Bug 58971 - mdoc bullet lists only work with item+term, but should be item+description
Summary: mdoc bullet lists only work with item+term, but should be item+description
Status: RESOLVED UPSTREAM
Alias: None
Product: Tools
Classification: Mono
Component: Doctools ()
Version: 5.2 (2017-04)
Hardware: PC Linux
: --- normal
Target Milestone: ---
Assignee: Bugzilla
URL:
Depends on:
Blocks:
 
Reported: 2017-08-23 12:26 UTC by Collegepark
Modified: 2017-09-01 08:49 UTC (History)
2 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on GitHub or Developer Community with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED UPSTREAM

Description Collegepark 2017-08-23 12:26:38 UTC
According 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 <description> with <term> it works, but this is not how it is supposed to be.
Comment 1 Marek Safar 2017-09-01 08:49:00 UTC
Please report mdoc issues at https://github.com/mono/api-doc-tools/issues