public override void BuildDocs(string outputPath)
{
outputPath = DocUtilities.ChangeExtension(outputPath, "md");
// Write markdown file
using (var writer = new MarkdownWriter(outputPath))
{
foreach (var type in Library.ExportedTypes.Where(t => !t.Name.StartsWith("_")).OrderBy(t => t.Name))
{
// Pull XML docs for type
var typeDocs = Docs[ID.GetIDString(type)];
// Header, e.g. "StringBuilder class (System)"
writer.WriteHeader(2, DocUtilities.GetTypeTitle(type, true), true);
// Summary and other info
PrintObsoleteWarning(type, writer);
writer.WriteParagraph($"**Namespace:** {type.Namespace}");
writer.WriteParagraph($"**Inheritance:** {DocUtilities.GetInheritanceString(type)}", true);
Summary(typeDocs, writer);
// Signature
writer.WriteCodeBlock(Lang, DocUtilities.GetClassSignature(type));
// Members
WriteConstructors(type, writer);
WriteProperties(type, writer);
WriteIndexers(type, writer);
WriteFields(type, writer);
WriteMethods(type, writer);
}
}
}
static void Main(string[] args)
{
var paths = Args.GetPaths();
if (paths.Length == 0 || Args.Help)
{
Console.WriteLine($"Usage: {AppDomain.CurrentDomain.FriendlyName} [OPTIONS]... <dll_pathfilename>");
Console.WriteLine();
Console.WriteLine($"Options:");
Console.WriteLine($" -out <path> Specifies the path where the docs will be saved.");
Console.WriteLine($" -xml <path> Specifies a custom XML documentation path.");
Console.WriteLine($" --slim Specifies that the docs will be combined into a single .md file.");
Console.WriteLine($" --noxml Don't use XML.");
Console.WriteLine($" --mgtable methods groups in type page will reported in a table with summary foreach method in the group");
Console.WriteLine($" --mgspace space vertically each method when reported in groups");
Console.WriteLine($" --proptable properties in type page will reported in a table with summary foreach");
return;
}
var dllPath = Path.GetFullPath(paths[0]);
var xmlPath = Args.Property("xml", DocUtilities.ChangeExtension(dllPath, "xml"));
var outputPath = Args.Property("out", "docs");
var outputDir = Path.GetDirectoryName(outputPath);
bool ignoreXML = Args.Flag("noxml");
// Check whether the file even exists
if (!File.Exists(dllPath))
{
Console.WriteLine($"File '{dllPath}' does not exist.");
return;
}
try
{
Console.WriteLine("Building docs...");
var dll = Assembly.LoadFrom(dllPath);
DocpalGenerator docpal;
var xmlData = new XmlDocument();
// Load XML document
if (File.Exists(xmlPath) && !ignoreXML)
{
xmlData.Load(xmlPath);
Console.WriteLine($"Found XML: {xmlPath}");
}
else
{
Console.WriteLine("No XML docs found, using only assembly...");
}
var xmlDocs = new ProjectXmlDocs(xmlData);
// Determine type of docs generator to use
if (Args.Flag("slim"))
{
docpal = new DocpalSlim(xmlDocs, dll);
}
else
{
docpal = new DocpalPages(xmlDocs, dll);
}
Directory.CreateDirectory(outputDir);
// Run build
docpal.BuildDocs(outputPath);
Console.WriteLine("Done, enjoy!");
}
catch (Exception e)
{
Console.WriteLine($"Unfortunately, there was an error.\n\n{e}");
Environment.Exit(1);
}
}
static void Main(string[] args)
{
var paths = Args.GetPaths();
if (paths.Length == 0)
{
Console.WriteLine("No path specified.");
return;
}
var dllPath = Path.GetFullPath(paths[0]);
var xmlPath = Args.Property("xml", DocUtilities.ChangeExtension(dllPath, "xml"));
var outputPath = Args.Property("out", "docs");
var outputDir = Path.GetDirectoryName(outputPath);
bool ignoreXML = Args.Flag("noxml");
// Check whether the file even exists
if (!File.Exists(dllPath))
{
Console.WriteLine($"File '{dllPath}' does not exist.");
return;
}
try
{
Console.WriteLine("Building docs...");
var dll = Assembly.LoadFile(dllPath);
DocpalGenerator docpal;
var xmlData = new XmlDocument();
// Load XML document
if (File.Exists(xmlPath) && !ignoreXML)
{
xmlData.Load(xmlPath);
Console.WriteLine($"Found XML: {xmlPath}");
}
else
{
Console.WriteLine("No XML docs found, using only assembly...");
}
var xmlDocs = new ProjectXmlDocs(xmlData);
// Determine type of docs generator to use
if (Args.Flag("slim"))
{
docpal = new DocpalSlim(xmlDocs, dll);
}
else
{
docpal = new DocpalPages(xmlDocs, dll);
}
Directory.CreateDirectory(outputDir);
// Run build
docpal.BuildDocs(outputPath);
Console.WriteLine("Done, enjoy!");
}
catch (Exception e)
{
Console.WriteLine($"Unfortunately, there was an error.\n\n{e}");
Environment.Exit(1);
}
}
