private static int GenerateDocRoot(GenerateDocRootCommandLineOptions options)
{
if (!TryParseVisibility(options.Visibility, out Visibility visibility))
{
return(1);
}
DocumentationModel documentationModel = CreateDocumentationModel(options.References, options.Assemblies, visibility);
if (documentationModel == null)
{
return(1);
}
if (!TryParseIgnoredRootParts(options.IgnoredParts, out RootDocumentationParts ignoredParts))
{
return(1);
}
var documentationOptions = new DocumentationOptions(
ignoredNames: options.IgnoredNames,
rootDirectoryUrl: options.RootDirectoryUrl,
includeClassHierarchy: !options.NoClassHierarchy,
placeSystemNamespaceFirst: !options.NoPrecedenceForSystem,
markObsolete: !options.NoMarkObsolete,
depth: options.Depth,
ignoredRootParts: ignoredParts,
omitContainingNamespaceParts: (options.OmitContainingNamespace) ? OmitContainingNamespaceParts.Root : OmitContainingNamespaceParts.None,
scrollToContent: options.ScrollToContent);
var generator = new MarkdownDocumentationGenerator(documentationModel, WellKnownUrlProviders.GitHub, documentationOptions);
string path = options.OutputPath;
WriteLine($"Documentation root is being generated to '{path}'.", Verbosity.Minimal);
string heading = options.Heading;
if (string.IsNullOrEmpty(heading))
{
string fileName = Path.GetFileName(options.OutputPath);
heading = (fileName.EndsWith(".dll", StringComparison.Ordinal))
? Path.GetFileNameWithoutExtension(fileName)
: fileName;
}
DocumentationGeneratorResult result = generator.GenerateRoot(heading);
File.WriteAllText(path, result.Content, _defaultEncoding);
WriteLine($"Documentation root successfully generated to '{path}'.", Verbosity.Minimal);
return(0);
}
private static int GenerateDoc(GenerateDocCommandLineOptions options)
{
if (options.MaxDerivedTypes < 0)
{
WriteLine("Maximum number of derived items must be equal or greater than 0.", ConsoleColor.Red, Verbosity.Quiet);
return(1);
}
if (!TryParseIgnoredRootParts(options.IgnoredRootParts, out RootDocumentationParts ignoredRootParts))
{
return(1);
}
if (!TryParseIgnoredNamespaceParts(options.IgnoredNamespaceParts, out NamespaceDocumentationParts ignoredNamespaceParts))
{
return(1);
}
if (!TryParseIgnoredTypeParts(options.IgnoredTypeParts, out TypeDocumentationParts ignoredTypeParts))
{
return(1);
}
if (!TryParseIgnoredMemberParts(options.IgnoredMemberParts, out MemberDocumentationParts ignoredMemberParts))
{
return(1);
}
if (!TryParseOmitContainingNamespaceParts(options.OmitContainingNamespaceParts, out OmitContainingNamespaceParts omitContainingNamespaceParts))
{
return(1);
}
if (!TryParseVisibility(options.Visibility, out Visibility visibility))
{
return(1);
}
DocumentationModel documentationModel = CreateDocumentationModel(options.References, options.Assemblies, visibility, options.AdditionalXmlDocumentation);
if (documentationModel == null)
{
return(1);
}
var documentationOptions = new DocumentationOptions(
ignoredNames: options.IgnoredNames,
preferredCultureName: options.PreferredCulture,
maxDerivedTypes: options.MaxDerivedTypes,
includeClassHierarchy: !options.NoClassHierarchy,
placeSystemNamespaceFirst: !options.NoPrecedenceForSystem,
formatDeclarationBaseList: !options.NoFormatBaseList,
formatDeclarationConstraints: !options.NoFormatConstraints,
markObsolete: !options.NoMarkObsolete,
includeMemberInheritedFrom: !options.OmitMemberInheritedFrom,
includeMemberOverrides: !options.OmitMemberOverrides,
includeMemberImplements: !options.OmitMemberImplements,
includeMemberConstantValue: !options.OmitMemberConstantValue,
includeInheritedInterfaceMembers: options.IncludeInheritedInterfaceMembers,
includeAllDerivedTypes: options.IncludeAllDerivedTypes,
includeAttributeArguments: !options.OmitAttributeArguments,
includeInheritedAttributes: !options.OmitInheritedAttributes,
omitIEnumerable: !options.IncludeIEnumerable,
depth: options.Depth,
inheritanceStyle: options.InheritanceStyle,
ignoredRootParts: ignoredRootParts,
ignoredNamespaceParts: ignoredNamespaceParts,
ignoredTypeParts: ignoredTypeParts,
ignoredMemberParts: ignoredMemberParts,
omitContainingNamespaceParts: omitContainingNamespaceParts,
scrollToContent: options.ScrollToContent);
var generator = new MarkdownDocumentationGenerator(documentationModel, WellKnownUrlProviders.GitHub, documentationOptions);
string directoryPath = options.OutputPath;
if (!options.NoDelete &&
Directory.Exists(directoryPath))
{
try
{
Directory.Delete(directoryPath, recursive: true);
}
catch (IOException ex)
{
WriteLine(ex.ToString(), ConsoleColor.Red, Verbosity.Quiet);
return(1);
}
}
var cts = new CancellationTokenSource();
Console.CancelKeyPress += (sender, e) =>
{
e.Cancel = true;
cts.Cancel();
};
CancellationToken cancellationToken = cts.Token;
WriteLine($"Documentation is being generated to '{options.OutputPath}'", Verbosity.Minimal);
foreach (DocumentationGeneratorResult documentationFile in generator.Generate(heading: options.Heading, cancellationToken))
{
string path = Path.Combine(directoryPath, documentationFile.FilePath);
Directory.CreateDirectory(Path.GetDirectoryName(path));
WriteLine($" Save '{path}'", ConsoleColor.DarkGray, Verbosity.Detailed);
File.WriteAllText(path, documentationFile.Content, _defaultEncoding);
}
WriteLine($"Documentation successfully generated to '{options.OutputPath}'.", Verbosity.Minimal);
return(0);
}
