[MDSAL-755] Improve javadoc of generated classes Created: 27/Apr/22  Updated: 11/Jul/22  Resolved: 22/Jun/22

Status: Resolved
Project: mdsal
Component/s: Binding codegen
Affects Version/s: None
Fix Version/s: 10.0.0

Type: Improvement Priority: Medium
Reporter: Robert Varga Assignee: Robert Varga
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split to MDSAL-758 Generate javadocs for Builder.withKey() Resolved
split to MDSAL-759 Improve javadoc for generated keys Resolved
split to MDSAL-760 Generate javadoc for unions Resolved
split to MDSAL-761 Generate javadoc for augments Resolved
split to MDSAL-762 Generate javadoc for ScalarTypes Resolved

 Description   

JDK17's javadoc has a number of new linters and is generally less happy about undocumented elements and notably about default constructors.

Improve code generator to include more expansive documentation of elements, so that the number of warnings is at a reasonable level.


Generated at Wed Feb 07 20:10:53 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.