DefaultDocumentation.PluginExample

This is an example of a plugin project to extend DefaultDocumentation features. The .targets file automatically adds the plugin to the <DefaultDocumentationPlugins> property so that referencing this plugin as a PackageReference is enough (you need to removed the <IsPackable>false</IsPackable> property from the csproj if you wish to do so).

• in case of a custom IFileNameFactory, you still need to select the one you want with the <DefaultDocumentationFileNameFactory> property or --FileNameFactory arg
• in case of a custom IElement, it will be automatically used
• in case of a custom ISection, you still need to use it explicitly in the <DefaultDocumentationSections> property or --Section arg

If you want to use a plugin that is in the same solution as your project, you need to reference it in a <DefaultDocumentationPlugins> property in your csproj, providing a path to the compiled dll.

...
<PropertyGroup>
    <DefaultDocumentationPlugins>$(SolutionDir)DefaultDocumentation.PluginExample/lib/netstandard2.0/DefaultDocumentation.PluginExample.dll</DefaultDocumentationPlugins>
</PropertyGroup>
...

FolderFileNameFactory

This is an example of a custom IFileNameFactory to generate a documentation organized in a folder hierarchy. Usage:

• msbuild task: <DefaultDocumentationFileNameFactory>Folder</DefaultDocumentationFileNameFactory>
• dotnet tool: --FileNameFactory Folder

NewElement

This is an example of a custom IElement to handle a new xml tag.

NewSection

This is an example of a custom ISection to add to the generated documentation. Usage:

• msbuild task: <DefaultDocumentationSections>New|Header|Default</DefaultDocumentationSections>
• dotnet tool: --Sections New Header Default