[YANGTOOLS-193] Add snippet of yang file into comments of generated classes Created: 23/Jun/14  Updated: 10/Apr/22  Due: 22/Jul/14  Resolved: 04/Aug/14

Status: Resolved
Project: yangtools
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement
Reporter: Devin Avery Assignee: Ladislav Borak
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: Mac OS
Platform: PC

Attachments: Zip Archive toaster-javadoc.zip    

 Description   

When we generate a class we should add some simple meta data to the comments to help people understand its purpose.

For example we should add, in addition to the "description" field in the yang file, the following information to the java comments:

1) Add a snippet of yang that this class represents
2) Add the type this file represents (i.e. notification, grouping, container etc)
3) Add java doc links to related generated classes
4) Add path name to yang file
5) Add java doc links to the gitweb file that the file was generated from (this would encompass part of #4 too so maybe we could skip that).

 Comments   
Comment by Ladislav Borak [ 23/Jul/14 ]

proposed patch: https://git.opendaylight.org/gerrit/#/c/9144/

Comment by Ladislav Borak [ 02/Aug/14 ]

Attachment toaster-javadoc.zip has been added with description: javadoc generated from toaster module

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