NetDocsProcessor

Change log

Unlike many libraries that produce output in predetermined HTML or Markdown formats, the NetDocsProcessor API provides a distinct approach for accessing data from an assembly and its associated XML file.

List<NamespaceDescription> data = new DocsProcessorApi().ObtainDocumentation(
        new AssemblyPaths("path_to_dll.dll", "path_to_xml.xml"),
        new GenerationSettings { AccessLevel = AccessLevel.Protected })
    .ToList();

The demo illustrates how to generate documentation files in Markdown format.

The list of supported xml tags

• <example>
• <exception>
• <include>
• <remarks>
• <returns>
• <param>
• <summary>
• <typeparam>

The tags <example>, <remarks> and <returns> support internal tags.