XmlDocMarkdownSettings class

Settings for markdown generation.

public class XmlDocMarkdownSettings

Public Members

name description
XmlDocMarkdownSettings() The default constructor.
ExternalDocs { get; set; } Configures external documentation.
FrontMatter { get; set; } If non-null, contains the path to a file that contains the Jekyll front matter template.
GenerateToc { get; set; } If true, generates a .yml file that can be used in a Jekyll based site.
IncludeObsolete { get; set; } If true, generates documentation for obsolete types and members. (Default false.)
IsDryRun { get; set; } If true, executes without making changes to the file system.
IsQuiet { get; set; } If true, suppresses normal console output.
NamespacePages { get; set; } Generate separate pages for each namespace containing list of types in each.
NewLine { get; set; } Indicates the newline used in the output.
PermalinkStyle { get; set; } Specify permalink style, ‘none’ or ‘pretty’ (default ‘none’). ‘pretty’ permalinks do not contain file extensions, and when you select this option periods have to be removed from file names, for example, ‘System.Console’ would have to be ‘SystemConsole’. since the removal of the ‘.md’ extension would make Jekyll think ‘.Console’ is a file extension which doesn’t work.
RootNamespace { get; set; } The root namespace of the input assembly.
ShouldClean { get; set; } If true, deletes previously generated files that are no longer used.
SkipUnbrowsable { get; set; } If true, skips documentation for types and members with [EditorBrowsable(EditorBrowsableState.Never)].
SourceCodePath { get; set; } The URL of the folder containing the source code of the assembly, e.g. at GitHub.
TocPrefix { get; set; } A path prefix to add to all links in the table of contents .yml file.
VisibilityLevel { get; set; } The minimum visibility for documented types and members.

See Also