PasDoc's autodoc

Unit PasDoc_Gen

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables

Description

basic doc generator object

PasDoc_Gen contains the basic documentation generator object TDocGenerator. It is not sufficient by itself but the basis for all generators that produce documentation in a specific format like HTML or LaTex. They override TDocGenerator's virtual methods.

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Record TOverviewFileInfo  
Class TListItemData Collected information about @xxxList item.
Class TListData Collected information about @xxxList content.
Class TRowData Collected information about @row (or @rowHead).
Class TTableData Collected information about @table.
Class TDocGenerator basic documentation generator object

Types

TOverviewFile = (...);
TCreatedOverviewFile = Low(TOverviewFile) .. ofIdentifiers;
TLinkLook = (...);
TLinkContext = (...);
TListType = (...);
TListItemSpacing = (...);

Constants

OverviewFilesInfo: array[TOverviewFile] of TOverviewFileInfo = ( (BaseFileName: 'AllUnits' ; TranslationId: trUnits ; TranslationHeadlineId: trHeadlineUnits ; NoItemsTranslationId: trNone ; ), (BaseFileName: 'ClassHierarchy'; TranslationId: trClassHierarchy ; TranslationHeadlineId: trClassHierarchy ; NoItemsTranslationId: trNoCIOs ; ), (BaseFileName: 'AllClasses' ; TranslationId: trCio ; TranslationHeadlineId: trHeadlineCio ; NoItemsTranslationId: trNoCIOs ; ), (BaseFileName: 'AllTypes' ; TranslationId: trTypes ; TranslationHeadlineId: trHeadlineTypes ; NoItemsTranslationId: trNoTypes ; ), (BaseFileName: 'AllVariables' ; TranslationId: trVariables ; TranslationHeadlineId: trHeadlineVariables ; NoItemsTranslationId: trNoVariables ; ), (BaseFileName: 'AllConstants' ; TranslationId: trConstants ; TranslationHeadlineId: trHeadlineConstants ; NoItemsTranslationId: trNoConstants ; ), (BaseFileName: 'AllFunctions' ; TranslationId: trFunctionsAndProcedures; TranslationHeadlineId: trHeadlineFunctionsAndProcedures; NoItemsTranslationId: trNoFunctions ; ), (BaseFileName: 'AllIdentifiers'; TranslationId: trIdentifiers ; TranslationHeadlineId: trHeadlineIdentifiers ; NoItemsTranslationId: trNoIdentifiers ; ), (BaseFileName: 'GVUses' ; TranslationId: trGvUses ; TranslationHeadlineId: trGvUses ; NoItemsTranslationId: trNone ; ), (BaseFileName: 'GVClasses' ; TranslationId: trGvClasses ; TranslationHeadlineId: trGvClasses ; NoItemsTranslationId: trNoCIOs ; ) );
LowCreatedOverviewFile = Low(TCreatedOverviewFile);
HighCreatedOverviewFile = High(TCreatedOverviewFile);

Description

Types

TOverviewFile = (...);

Overview files that pasdoc generates for multiple-document-formats like HTML (see TGenericHTMLDocGenerator).

But not all of them are supposed to be generated by pasdoc, some must be generated by external programs by user, e.g. uses and class diagrams must be made by user using programs such as GraphViz. See type TCreatedOverviewFile for subrange type of TOverviewFile that specifies only overview files that are really supposed to be made by pasdoc.

Values
  • ofUnits
  • ofClassHierarchy
  • ofCios
  • ofTypes
  • ofVariables
  • ofConstants
  • ofFunctionsAndProcedures
  • ofIdentifiers
  • ofGraphVizUses
  • ofGraphVizClasses
TCreatedOverviewFile = Low(TOverviewFile) .. ofIdentifiers;
 
TLinkLook = (...);
 
Values
  • llDefault
  • llFull
  • llStripped
TLinkContext = (...);

This is used by TDocGenerator.MakeItemLink

Values
  • lcCode: This means that link is inside some larger code piece, e.g. within FullDeclaration of some item etc. This means that we may be inside a context where used font has constant width.
  • lcNormal: This means that link is inside some "normal" description text.
TListType = (...);
 
Values
  • ltUnordered
  • ltOrdered
  • ltDefinition
TListItemSpacing = (...);
 
Values
  • lisCompact
  • lisParagraph

Constants

OverviewFilesInfo: array[TOverviewFile] of TOverviewFileInfo = ( (BaseFileName: 'AllUnits' ; TranslationId: trUnits ; TranslationHeadlineId: trHeadlineUnits ; NoItemsTranslationId: trNone ; ), (BaseFileName: 'ClassHierarchy'; TranslationId: trClassHierarchy ; TranslationHeadlineId: trClassHierarchy ; NoItemsTranslationId: trNoCIOs ; ), (BaseFileName: 'AllClasses' ; TranslationId: trCio ; TranslationHeadlineId: trHeadlineCio ; NoItemsTranslationId: trNoCIOs ; ), (BaseFileName: 'AllTypes' ; TranslationId: trTypes ; TranslationHeadlineId: trHeadlineTypes ; NoItemsTranslationId: trNoTypes ; ), (BaseFileName: 'AllVariables' ; TranslationId: trVariables ; TranslationHeadlineId: trHeadlineVariables ; NoItemsTranslationId: trNoVariables ; ), (BaseFileName: 'AllConstants' ; TranslationId: trConstants ; TranslationHeadlineId: trHeadlineConstants ; NoItemsTranslationId: trNoConstants ; ), (BaseFileName: 'AllFunctions' ; TranslationId: trFunctionsAndProcedures; TranslationHeadlineId: trHeadlineFunctionsAndProcedures; NoItemsTranslationId: trNoFunctions ; ), (BaseFileName: 'AllIdentifiers'; TranslationId: trIdentifiers ; TranslationHeadlineId: trHeadlineIdentifiers ; NoItemsTranslationId: trNoIdentifiers ; ), (BaseFileName: 'GVUses' ; TranslationId: trGvUses ; TranslationHeadlineId: trGvUses ; NoItemsTranslationId: trNone ; ), (BaseFileName: 'GVClasses' ; TranslationId: trGvClasses ; TranslationHeadlineId: trGvClasses ; NoItemsTranslationId: trNoCIOs ; ) );
 
LowCreatedOverviewFile = Low(TCreatedOverviewFile);

Using High(TCreatedOverviewFile) or High(Overview) where Overview: TCreatedOverviewFile in PasDoc_GenHtml produces internal error in FPC 2.0.0. Same for Low(TCreatedOverviewFile).

This is submitted as FPC bug 4140, [http://www.freepascal.org/bugs/showrec.php3?ID=4140]. Fixed in FPC 2.0.1 and FPC 2.1.1.

HighCreatedOverviewFile = High(TCreatedOverviewFile);
 

Authors

Created

30 Aug 1998

Generated by PasDoc 0.16.0.