Class GenDocFX

Generates documentation using DocFX. Divided into two stages:

  1. Creating YML files from the DLL file (compilation result);
  2. Creating HTML from the YML files obtained in the previous stage. Thus:
  • For managed DLLs, both stages are performed
  • For native DLLs (and in all other cases), manual YML generation and the second stage are performed "Manual generation" refers to using the build system module. First stage:
  • For C# projects: Run the docfx metadata command to generate .yml files using a previously compiled .NET DLL as input.
  • For IDL projects: Run the docfx metadata command to generate .yml files using a previously compiled .NET DLL as input.
  • For Delphi projects: Read the XML (obtained during project compilation) and generate .yml files.
  • For C++ projects: Read the XML (obtained during project compilation) and generate .yml files.
  • For RES projects: Documentation generation is not performed. Second stage - run the docfx build command, which references the docfx.json file located in the documentation directory. The second stage has two execution options:
  • Combine YML files into a temporary directory and generate docfx.json "on the fly".
  • Combine YML files into an existing directory where docfx.json already exists. In this case, the user can write MD files, effectively including any additional information in the documentation.
Inheritance
object
GenDocFX
Implements
Namespace: BuildSystem.GenDoc.DocFX
Assembly: BuildSystem.GenDoc.DocFX.dll
Syntax
public class GenDocFX : Object, IGenDoc, IManager

Constructors

GenDocFX(ILogger?, GenDocFXProps, string)

Creates .lng file using utility written on Delphi

Declaration
public GenDocFX(ILogger? logger, GenDocFXProps props, string tempDir)
Parameters
Type Name Description
ILogger logger

Logger
GenDocFXProps props

Properties
string tempDir

Temp folder for private use

Fields

ClassIdent

Unique ident of class

Declaration
public const string ClassIdent = "GenDoc.DocFX"
Field Value
Type Description
string

Properties

Logger

Declaration
public ILogger? Logger { get; }
Property Value
Type Description
ILogger

Props

Declaration
public IManagerProp Props { get; }
Property Value
Type Description
IManagerProp

Methods

Generate(Dictionary<string, ReaderType>, string?)

Creates YML-files to be used by DocFX

Declaration
public void Generate(Dictionary<string, ReaderType> sources, string? targetFolder)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<,><string, ReaderType> sources

Path to source documentation files
string targetFolder

Path for results site files. If is null - site files won't be created

Implements