Docfx: Docfx Comment API generated not support some advantage tag like bullet

Created on 17 Mar 2016  路  2Comments  路  Source: dotnet/docfx

Hi all,

I've generated api help using Docfx but it not support some tag in .NET comment like: list, bullet, typeparam, para, dictionary<int>. SandCastle support this.
Do you have any plan to add these tags in next version?

Regards
Tung

Most helpful comment

I wonder if an improvement to list handling could be implemented:

The following C# xml comment:

<list type="bullet">
<item>This method is for testing purpose</item>
<item>It's useless to call it</item>
</list>

generates this yaml:

remarks: "\n<ul><li></li><li></li></ul>\n"

I know I should enclose my text in <description> tags. However I think it would be useful to also support the form with only the <item> tag.

All 2 comments

@tungnt185 it is already supported in dev.

I wonder if an improvement to list handling could be implemented:

The following C# xml comment:

<list type="bullet">
<item>This method is for testing purpose</item>
<item>It's useless to call it</item>
</list>

generates this yaml:

remarks: "\n<ul><li></li><li></li></ul>\n"

I know I should enclose my text in <description> tags. However I think it would be useful to also support the form with only the <item> tag.

Was this page helpful?
0 / 5 - 0 ratings