C# Класс Projbook.Core.ProjbookEngine

Entry point for document generation. Setup your generation environment using the right constructor and run the process with Generate() method.
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
Generate ( Configuration configuration ) : Projbook.Core.Model.GenerationError[]

Generates documentation.

GenerateAll ( ) : Projbook.Core.Model.GenerationError[]

Generates all documents.

GenerateIndex ( IndexConfiguration indexConfiguration ) : Projbook.Core.Model.GenerationError[]

Generates the index page for the documentation.

ProjbookEngine ( IFileSystem fileSystem, string csprojFile, string extensionPath, IndexConfiguration indexConfiguration, string outputDirectoryPath, bool skipPdf ) : System

Initializes a new instance of ProjbookEngine.

Приватные методы

Метод Описание
ExtractSourceDirectories ( System.IO.Abstractions.FileInfoBase csprojFile ) : System.IO.Abstractions.DirectoryInfoBase[]

Extracts source directories from the csproj file. The expected directory info list is the csproj's directory and all project references.

GenerateFile ( string templateName, string outputFileHtml, Configuration configuration, List pages ) : void

Generates a file.

GenerateIndexFile ( string templateName, string outputFileHtml, IndexConfiguration indexConfiguration ) : void

Generates the index file.

LocateBlockLine ( CommonMark.Syntax.Block block, Page page ) : int

Computes line number of a block in a page.

RegisterHtmlToXLibraries ( ) : void

Register HtmlToX libraries.

StringFromByteArray ( byte data, long startIndex, long length ) : string

Extracts a string from a byte array.

WriteFile ( string templateName, string outputFileHtml, Object fileConfiguration ) : void

Write to the documentation file.

Описание методов

Generate() публичный Метод

Generates documentation.
public Generate ( Configuration configuration ) : Projbook.Core.Model.GenerationError[]
configuration Projbook.Core.Model.Configuration.Configuration
Результат Projbook.Core.Model.GenerationError[]

GenerateAll() публичный Метод

Generates all documents.
public GenerateAll ( ) : Projbook.Core.Model.GenerationError[]
Результат Projbook.Core.Model.GenerationError[]

GenerateIndex() публичный Метод

Generates the index page for the documentation.
public GenerateIndex ( IndexConfiguration indexConfiguration ) : Projbook.Core.Model.GenerationError[]
indexConfiguration Projbook.Core.Model.Configuration.IndexConfiguration The index configuration.
Результат Projbook.Core.Model.GenerationError[]

ProjbookEngine() публичный Метод

Initializes a new instance of ProjbookEngine.
public ProjbookEngine ( IFileSystem fileSystem, string csprojFile, string extensionPath, IndexConfiguration indexConfiguration, string outputDirectoryPath, bool skipPdf ) : System
fileSystem IFileSystem Initializes the required file system abstraction.
csprojFile string Initializes the required .
extensionPath string Initializes the required extension path.
indexConfiguration Projbook.Core.Model.Configuration.IndexConfiguration Initializes the required .
outputDirectoryPath string Initializes the required .
skipPdf bool Initializes the required .
Результат System