Skip to content

A command-line tool that postprocesses XML documents and replaces <inheritdoc/> elements with actual comments.

License

Notifications You must be signed in to change notification settings

Artees/InheritdocInliner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The <inheritdoc/> XML comments tag allows documentation to be inherited from base types/members, which reduces the effort required to write documentation. However, some tools don't support this feature. InheritdocInliner is a command-line tool that postprocesses XML files and replaces <inheritdoc/> elements with actual comments.

Installation

Install the NuGet package or download the latest EXE from GitHub.

Usage

path\to\InheritdocInliner.exe path\to\docs.xml

Command line arguments:

Argument Description
--help Display the help screen.
--version Display version information.
-x, --xml (pos. 0) The XML document to be processed.
-d, --dll (pos. 1) The assembly file for which the XML document is processed. If not specified, the path of the XML document will be used.
-o, --output (pos. 2) The path of the output XML document. If not specified, the original document will be overwritten.

About

A command-line tool that postprocesses XML documents and replaces <inheritdoc/> elements with actual comments.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published