[YANGTOOLS-175] Generated javadoc comments poorly formatted Created: 29/May/14  Updated: 10/Apr/22  Due: 14/Jul/14  Resolved: 22/Jul/14

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

Type: Bug
Reporter: Rob Adams Assignee: Ladislav Borak
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: Linux
Platform: PC


External issue ID: 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.
    */


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

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

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