search

ejball / XmlDocMarkdown

Generates Markdown from .NET XML documentation comments.
https://ejball.com/XmlDocMarkdown/
MIT License
102 stars 30 forks source link

Support <inheritdoc/> #87

Open bgrainger opened 4 years ago

bgrainger commented 4 years ago

Code authors can use <inheritdoc/> to "inherit XML comments from base classes, interfaces, and similar methods" (source).

The most common use case is when overriding a base class method, but the documentation implies that you can "add your XML comments to your synchronous methods and let InheritDoc copy the comments to your asynchronous versions of the same methods."

It would be nice if XmlDocMarkdown supported:

  1. Inheriting documentation for overridden methods.
  2. Copying sync method documentation to async methods.
bgrainger commented 4 years ago

Even the code for this library acknowledges that <inheritdoc/> isn't supported: https://github.com/ejball/XmlDocMarkdown/commit/4a3e15f217df25be6b42d6166a5a7657561c2017.

nicolaiarocci commented 1 year ago

In many projects you have abstract classes with their virtual methods documented. Inheriting classes can avoid most xml comments, as members are documented in the base class.

The current output forces an user to browse through all the inheritance tree in order to get the whole picture of what a class can do. Many times, people being lazy or unaware, the information is lost as they have to first click the parent class in the See Also section... which contains several other links.

Adding <inhericdoc/> support would be great.