[MDSAL-416] Generated javadoc does not separate multi-line description Created: 21/Jan/19 Updated: 26/Mar/19 Resolved: 26/Mar/19 |
|
| Status: | Resolved |
| Project: | mdsal |
| Component/s: | Binding codegen |
| Affects Version/s: | None |
| Fix Version/s: | 4.0.0, Fluorine SR3, 3.0.7 |
| Type: | Bug | Priority: | Medium |
| Reporter: | Robert Varga | Assignee: | Robert Varga |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
The following snippet: enum unlocked {
value 4;
description
"The resource is not administratively prohibited from
use.";
}
results in javadoc which says: The resource is not administratively prohibited fromuse. We are obviously missing a whitespace conversion, because while the whitespace before "use" should be compressed, the newline after from should be interpreted as a single space. |
| Comments |
| Comment by Jie Han [ 25/Jan/19 ] |
|
When I put snippet into a sample comment, I got this: And for generated bindings, the decription defined in yang file would be omitted by the generator, |
| Comment by Robert Varga [ 25/Jan/19 ] |
|
For example in the ietf-origin model, note you must not use "-Pq" during build, as that skips javadoc, here is an example output:
|