[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 |
||
| External issue ID: | 1102 |
| Description |
|
In yang, typically a description field will be formatted something like this: The generated javadoc then comes out like: /** 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:
|
| Comments |
| Comment by Ladislav Borak [ 14/Jul/14 ] |
|
proposed patch https://git.opendaylight.org/gerrit/#/c/8592/ |