command-line-api
command-line-api copied to clipboard
dotnet
<summary> parsing by DragonFruit doesn't understand <para>
I'd like a line break in the help text produced from <summary> docs.
It seems that line breaks are ignored (understandably). Adding <para> elements doesn't help (in fact, it removed whitespace between paragraphs).
Perhaps a separate issue, but it'd be nice to use the <summary> section for the brief description, and the <remarks> section for more detailed information.
@jonsequitur I am wondering if we want Description in Symbol to be more complex object than a string. Changing to a complex object could have a large impact on unit tests. The help process assigns the XML document text to Description. Description is cleaned of new lines and whitespace and is finally split into lines to fit the screen. A more complex object would allow us to store lines of descriptions intentionally and <remarks>.
Another option would be to keep the <para> and <remarks> tags in the description and parse them out when the description is printed.
Hi @drewnoakes .
Have a look over this screenshot
It seems that the para tag inside the summary tag is not ignored. Is this the intended behavior you wanted?
Can I Resolve This Issue & Can U Help Me With Start It ?..
I don't have any updates on this. Feel free to work on it and see if it reproduces.
How about implement the same behavior of intelissense?
/// <summary>
/// First paragraph.
/// Second paragraph.
/// <para>Third paragraph.</para>
/// <para>Fourth paragraph.</para>
/// Fifty paragraph.
/// </summary>
Will generate:
First paragraph. Second paragraph.
Third paragraph.
Fourth paragraph.
Fifty paragraph.
Commands with bad format like bellow will be ignorated and prints an warning like CS1570.
/// <summary>
/// First paragraph.<para>
/// </summary>
IIUC according to https://github.com/dotnet/command-line-api/pull/2008#issue-1514102631 this issue can be closed.
Presumably fixed with https://github.com/dotnet/command-line-api/pull/1604 which was released in v2.0.0-beta3.22114.1.
