Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
157 stars 26 forks source link

Missing information (<b> tag) in namespace table documentation #67

Closed petarpetrovt closed 3 years ago

petarpetrovt commented 3 years ago

DefaultDocumentation: 0.7.6-beta1 TargetFramework: NET6.0

Code:

/// <summary>
/// Represents a <b>16</b> bit handle in <b>I08V08</b> format.
/// </summary>
/// <remarks>
/// <br>- <b>08</b> bits for the handle index (<i>0</i> - <i>254</i>)</br>
/// <br>- <b>08</b> bits for the handle version (<i>0</i> - <i>255</i>)</br>
/// <br>- index <i>255</i> is reserved for <b>NULL</b></br>
/// </remarks>
public readonly struct I08V08Handle

Generated namespace docs: doc-namesapce

Generated struct docs: doc-struct

Doraku commented 3 years ago

ah yes this is the problematic line https://github.com/Doraku/DefaultDocumentation/blob/6441ea912d21a3323ee791c4c6c50616d2501555/source/DefaultDocumentation.Common/Writer/MarkdownWriter.cs#L261 The condition is too greedy I will see what I can do. (the idea was to ignore stuff like <code> element which can't be rendered in a single line with for the table preview)