One of the goals of this Xdoc automation project is to gut the Javadocs. The problem is that they can not be deleted immediately. The metadata scraper relies on these Javadocs to generate the XML metadata files:
|
/** |
|
* Class for scraping module metadata from the corresponding class' class-level javadoc. |
|
*/ |
|
@FileStatefulCheck |
|
public class JavadocMetadataScraper extends AbstractJavadocCheck { |
After the properties macro (#13407) is merged, we will have all the functionality to make this rewrite possible - properties macro, parent module macro, violation messages macro. Additionally, a module will have to be written to get the description from the Xdoc.
All the functionality that those macros use is kept at SiteUtil.
The purpose of this issue: Initially, we should extend the metadata module to be able to work with both the Javadoc metadata scraper that it's using now, and the new functionality that the Xdocs use.
This way we can slowly start gutting Javadocs. Once all java docs are removed, we can remove the old javadoc metdata scraper. But these will be followup issues.
Incomplete PR but 95% done it is better to reuse it: #13670
One of the goals of this Xdoc automation project is to gut the Javadocs. The problem is that they can not be deleted immediately. The metadata scraper relies on these Javadocs to generate the XML metadata files:
checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/meta/JavadocMetadataScraper.java
Lines 48 to 52 in 98e74d0
After the properties macro (#13407) is merged, we will have all the functionality to make this rewrite possible - properties macro, parent module macro, violation messages macro. Additionally, a module will have to be written to get the description from the Xdoc.
All the functionality that those macros use is kept at
SiteUtil.The purpose of this issue: Initially, we should extend the metadata module to be able to work with both the Javadoc metadata scraper that it's using now, and the new functionality that the Xdocs use.
This way we can slowly start gutting Javadocs. Once all java docs are removed, we can remove the old javadoc metdata scraper. But these will be followup issues.
Incomplete PR but 95% done it is better to reuse it: #13670