DocFxMarkdownGen
DocFxMarkdownGen copied to clipboard
Full recommended tags support
From https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags.
- General Tags used for multiple elements - These tags are the minimum set for any API.
- [x] <summary>: The value of this element is displayed in IntelliSense in Visual Studio.
- [ ] <remarks>: Tags used for members - These tags are used when documenting methods and properties.
- [x] <returns>
- [x] <param>
- [ ] <paramref>
- [x] <exception>
- Format documentation output - These tags provide formatting directions for tools that generate documentation.
- [ ] <para>
- [ ] <list>
- [x] <c>
- [x] <code>
- [ ] #7
- [x] <inheritdoc> (should be handled by docfx itself)
- [ ] <include>
- Generate links and references - These tags generate links to other documentation.
- [ ] <see>
- [ ] <seealso>
- [ ] cref
- [ ] href - maybe already is?
- Tags for generic types and methods - These tags are used only on generic types and methods
- [x] <typeparam>
- [ ] <typeparamref>
the compiler and Visual Studio validate the <b>, <i>, <u>, <br/>, and <a> tags.
- [ ] <b>
- [ ] <i>
- [ ] <u>
- [x] <br/> (also support <br /> with the space just to be sure)
- [ ] <a>
Soo big task! Waiting for v1.0 😆