api-doc-tools

api-doc-tools copied to clipboard

ccording to Microsoft documentation the bullet list's items should have description subtags (https://docs.microsoft.com/de-de/dotnet/csharp/programming-guide/xmldoc/list)

/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>

In this case mdoc will only create empty XML items and HTML will only show the bullets but no text. If I replace with it works, but this is not how it is supposed to be.

Thanks for letting us know about this issue @collegedude ... just to be clear, I wanted to verify how you are generating HTML. Are you using mdoc's export-html subcommand?

@joelmartinez : I am using mdoc-export-html for HTML output and mdoc update to generate the XML.

I just stumbled across the same discrepancy - is there agreement that the better/more correct syntax for bullet and number lists would be to use description rather than term? (I'm trying to decide which one to use in XML doc comments I'm writing today.)

Thanks,

David