Uploaded image for project: 'mdsal'
  1. mdsal
  2. MDSAL-482

Make yang module html documentation more user friendly.

    XMLWordPrintable

Details

    • Improvement
    • Status: Confirmed
    • Low
    • Resolution: Unresolved
    • None
    • None
    • Binding codegen
    • 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.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            Unassigned Unassigned
            michal.rehak Michal Rehak
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: