Uploaded image for project: 'yangtools'
  1. yangtools
  2. YANGTOOLS-175

Generated javadoc comments poorly formatted

    XMLWordPrintable

Details

    • Bug
    • Status: Resolved
    • Resolution: Done
    • None
    • None
    • None
    • None
    • Operating System: Linux
      Platform: PC

    • 1102

    Description

      In yang, typically a description field will be formatted something like this:
      {
      description
      "Lorem ipsum dolor sit amet, consectetur adipisicing elit,
      sed do eiusmod tempor incididunt ut labore et dolore
      magna aliqua. Ut enim ad minim veniam, quis nostrud
      exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat. Duis aute irure dolor in reprehenderit
      in voluptate velit esse cillum dolore eu fugiat nulla
      pariatur. Excepteur sint occaecat cupidatat non proident,
      sunt in culpa qui officia deserunt mollit anim id est
      laborum.";
      }

      The generated javadoc then comes out like:

      /**
      Lorem ipsum dolor sit amet, consectetur adipisicing elit,
      sed do eiusmod tempor incididunt ut labore et dolore
      magna aliqua. Ut enim ad minim veniam, quis nostrud
      exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat. Duis aute irure dolor in reprehenderit
      in voluptate velit esse cillum dolore eu fugiat nulla
      pariatur. Excepteur sint occaecat cupidatat non proident,
      sunt in culpa qui officia deserunt mollit anim id est
      laborum.
      */

      We should be smarter about formatting these comments into nice paragraphs. I would propose that we look for paragraphs and reformat them into properly line-wrapped 80-column paragraphs.

      Also it would be nice to format with the leading * characters:
      /**

      • Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
      • do eiusmod tempor incididunt ut labore et dolore magna
      • aliqua. Ut enim ad minim veniam, quis nostrud exercitation
      • ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis
      • aute irure dolor in reprehenderit in voluptate velit esse
      • cillum dolore eu fugiat nulla pariatur. Excepteur sint
      • occaecat cupidatat non proident, sunt in culpa qui officia
      • deserunt mollit anim id est laborum.
        */

      Attachments

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

        Activity

          People

            lborak@cisco.com Ladislav Borak
            readams Rob Adams
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: