PasDoc's autodocOverview Units Class Hierarchy Classes, Interfaces, Objects and Records Types Variables Constants Functions and Procedures Identifiers Unit dependency graph Classes hierarchy graph
|
Unit PasDoc_Gen
Functions and Procedures 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
Types
Constants
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
|
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
|
Constants
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.
|
Authors
Created
30 Aug 1998
Generated by PasDoc 0.15.0.
|