[MDSAL-761] Generate javadoc for augments Created: 11/Jul/22  Updated: 05/Aug/22  Resolved: 05/Aug/22

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

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

Issue Links:
Issue split
split from MDSAL-755 Improve javadoc of generated classes Resolved

 Description   

Modern versions of default doclet are generating this warning:

[WARNING] /home/nite/odl/mdsal/binding/mdsal-binding-test-model/target/generated-sources/BindingJavaFileGenerator/org/opendaylight/yang/gen/v1/urn/test/opendaylight/bug/_5524/module1/rev160101/uses/grouping/augmet/testgrouping/outer/ContainerAugmet11.java:17: warning: no comment
[WARNING] public interface ContainerAugmet11
[WARNING] ^

Since normal interfaces already include documentation, this seems to be an omission in mdsal-binding-generator's AbstractAugmentGenerator.createTypeImpl. Generated javadoc should include a reference to the augmentation target, module name as well as the corresponding "augment foo" YANG snippet.
Generated at Wed Feb 07 20:10:54 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.