Unit Command.Docs

Description
Functions and Procedures
Constants

Description

This unit contains procedures to configure and execute a command to generate the project documentation with pasdoc, from the pages in docs/generate and the project sources. It replaces the docs/generate/build.ps1 script that pasc add –docs used to create.

Overview

Functions and Procedures

procedure DocsCommand(ABuilder: ICommandBuilder);
procedure Registry(ABuilder: ICommandBuilder);

Constants

DOCS_SOURCE_DIR = 'docs/generate';
DOCS_OUTPUT_DIR = 'docs';

Description

Functions and Procedures

procedure DocsCommand(ABuilder: ICommandBuilder);

Generates the documentation with pasdoc, by convention: - docs/generate/introduction.txt is the introduction, and conclusion.txt the conclusion; - every other docs/generate/*.txt is an additional page; the command*.txt pages are grouped as Commands in the menu, after the other pages; - the sources are the units in the search paths of the project (.lpi or .lpk) in the current folder, and its main program; at the root of a workspace, of every member; - docs/generate/custom.css, when it exists, replaces the pasdoc stylesheet. The output goes to docs. The exit code is 1 when pasdoc is missing or fails.

Parameters
ABuilder
Command builder of the main application that will be used to output info about the generation.
procedure Registry(ABuilder: ICommandBuilder);

Registry a docs command using the command builder from pascli.

Parameters
ABuilder
Command builder of the main application that will be used to registry the command.

Constants

DOCS_SOURCE_DIR = 'docs/generate';

Folder of the documentation pages, relative to the project root.

DOCS_OUTPUT_DIR = 'docs';

Folder of the generated documentation, relative to the project root.

Generated by PasDoc 1.0.4.