[jira] [Resolved] (GROOVY-9775) Rework gradle build to use modern conventions - doc remediation

Previous Topic Next Topic
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Resolved] (GROOVY-9775) Rework gradle build to use modern conventions - doc remediation

Eric Milles (Jira)

     [ https://issues.apache.org/jira/browse/GROOVY-9775?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Paul King resolved GROOVY-9775.
    Resolution: Fixed

I am going to mark this as fixed. The new doc is now like-for-like in most places but has a few improvements:

* package.html info is populated in javadocAll for modules (previously it was included just for core packages)
* some generated Antlr4 files no longer appear in the javadoc (most would regard them as noise and not useful)
* the groovy-jaxb documentation is now included with other optional modules
* groovy-all javadoc/groovydoc now longer includes the optional modules (to match the source) and what you are getting from the pom (they still appear in the full doc zip)

There are some minor improvements we can still look to make for the single-page documentation and single page pdf.

> Rework gradle build to use modern conventions - doc remediation
> ---------------------------------------------------------------
>                 Key: GROOVY-9775
>                 URL: https://issues.apache.org/jira/browse/GROOVY-9775
>             Project: Groovy
>          Issue Type: Task
>            Reporter: Paul King
>            Assignee: C├ędric Champeau
>            Priority: Major
>             Fix For: 4.0.0-alpha-2
> The various build scripts and associated artifacts have been written by numerous folks targeting numerous versions of Gradle over many years. The styles have drifted apart and some places use very old conventions/style. We should consolidate/update as needed.
> *Cloned* to track some differences in doc generation results. We aren't necessarily attempting to get like for like if what was done previously can be improved.
> (/) The groovy-jdk documentation is not populated FIXED
> (/) The old allgroovydoc/alljavadoc contents included doc for classes from optional modules which wasn't correct and is now fixed. However, the doc zip should include such doc for all files like it previously did but no longer does.
> (/) package.html file information isn't being produced

This message was sent by Atlassian Jira