[MDSAL-482] Make yang module html documentation more user friendly. Created: 04/Mar/15  Updated: 25/Jun/21

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

Type: Improvement Priority: Low
Reporter: Michal Rehak Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: pt
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All



 Description   

There are several points where the html documentation can be made more useful:

  • module: missing description
  • module.imports: one per line, add prefixes
  • groupings (especially large ones)
  • could be collapsable
  • should contain links to subgroupings (if reachable locally) or at collapse by default
  • augmentations miss name/identifier
  • augmentation target should use prefixes instead of full namespaces (full namespace can be provided via tooltip on pefix)
  • general coloring - deprecated elements should use gray color or strikeout.


 Comments   
Comment by Michal Rehak [ 04/Mar/15 ]

Update: module does not miss description but module.revision does.

Comment by Robert Varga [ 20/Feb/18 ]

This relates to YangTextSnippet, which can be expanded to a full Javadoc export, except for linking, which really is the domain of binding spec.

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