Namespace BuildSystem.GenDoc.DocFX

Classes

CppReader

Reads .XML (which is received from Visual Studio after compiling C++ project)

CSharpConverter

Reading build results of C# projects and converting them into YML files (using DocFX). These YML files could be used later by call docfx build

DelphiReader

Reads .XML (which is received from RAD Studio after compiling project)

GenDocFX

Generates documentation using DocFX. Divided into two stages:

Creating YML files from the DLL file (compilation result);
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.

Container of properties for classes implementing GenDocFX The OutputYml and DocFxJsonPath settings are used only when there are manually written MD files that should also be included in the documentation. In other words, the developer has: