Unit PasDoc_Items
Description
All items that can appear within Pascal source code.
For each item (type, variable, class etc.) that may appear in a Pascal source code file and can thus be taken into the documentation, this unit provides an object type which will store name, unit, description and more on this item.
Source: source/component/PasDoc_Items.pas (line 38).
Uses
- SysUtils
- Classes
- Contnrs
- Generics.Collections
- Generics.Defaults
- PasDoc_Types
- PasDoc_StringVector
- PasDoc_TagManager
- PasDoc_Serialize
- PasDoc_SortSettings
- PasDoc_StringPairVector
- PasDoc_Tokenizer
Overview
Classes, Interfaces, Objects and Records
| Name | Description |
|---|---|
Record TRawDescriptionInfo |
Raw description, in other words: the contents of comment before given item. |
Class TBaseItem |
This is a basic item class, that is linkable, and has some RawDescription. |
Class TPasItem |
This is a TBaseItem descendant that is always declared inside some Pascal source file. |
Class TPasConstant |
Pascal constant. |
Class TPasFieldVariable |
Global variable or a field in CIO. |
Class TPasType |
Pascal type (but not a procedural type — these are expressed as TPasRoutine.) |
Class TPasAliasType |
Alias type |
Class TPasEnum |
Enumerated type. |
Class TPasRoutine |
This represents:
|
Class TPasProperty |
|
Class TPasCio |
Extends TPasItem to store all items in a class / an object, e.g. fields. |
Class EAnchorAlreadyExists |
|
Class TExternalItem |
TExternalItem extends TBaseItem to store extra information about a project. |
Class TAnchorItem |
|
Class TPasUnit |
extends TPasItem to store anything about a unit, its constants, types etc.; also provides methods for parsing a complete unit. |
Class TBaseItems |
Container class to store a list of TBaseItems. |
Class TPasItems |
Container class to store a list of TPasItems. |
Class TPasRoutines |
Collection of methods. |
Class TPasProperties |
Collection of properties. |
Class TPasTypes |
List of types. |
Class TPasNestedCios |
Collection of CIOs (classes, records, interfaces...) nested in outer CIO. |
Class TPasUnits |
Collection of units. |
Functions and Procedures
function RoutineTypeToString(const RoutineType: TRoutineType): string; |
function CioTypeToString(const CioType: TCIOType): String; |
function VisibilitiesToStr(const Visibilities: TVisibilities): string; |
function VisToStr(const Vis: TVisibility): string; |
function ObjectVectorIsNilOrEmpty(const List: TBaseItems): boolean; overload; |
Types
TVisibility = (...); |
TVisibilities = set of TVisibility; |
TInfoMergeType = (...); |
PRawDescriptionInfo = ˆTRawDescriptionInfo; |
THintDirective = (...); |
THintDirectives = set of THintDirective; |
TRoutineType = (...); |
TCIOType = (...); |
TClassDirective = (...); |
TExternalItemList = specialize TObjectList<TExternalItem>; |
TBaseItemDictionary = specialize TDictionary<String, TBaseItem>; |
TStringStringDictionary = specialize TDictionary<String, String>; |
Constants
VisibilityStr: array[TVisibility] of string[16] =
(
'published',
'public',
'protected',
'strict protected',
'private',
'strict private',
'automated',
'implicit'
); |
AllVisibilities = [Low(TVisibility) .. High(TVisibility)]; |
DefaultVisibilities = [Low(TVisibility) .. High(TVisibility)] -
[viPrivate, viStrictPrivate, viImplicit]; |
InfoMergeTypeStr: array[TInfoMergeType] of string = (
'none',
'prefer-interface',
'prefer-implementation',
'join'
); |
CIORecordType = [CIO_RECORD, CIO_PACKEDRECORD]; |
CIONonHierarchy = CIORecordType; |
EmptyRawDescriptionInfo: TRawDescriptionInfo =
( Content: ''; StreamName: ''; BeginPosition: -1; EndPosition: -1; ); |
Description
Functions and Procedures
function RoutineTypeToString(const RoutineType: TRoutineType): string; |
|
Returns lowercased keyword associated with given method type. |
function CioTypeToString(const CioType: TCIOType): String; |
|
Returns lowercased keyword(s) associated with given structure type. |
function VisibilitiesToStr(const Visibilities: TVisibilities): string; |
|
Returns VisibilityStr for each value in Visibilities, delimited by commas. |
function VisToStr(const Vis: TVisibility): string; |
|
This item has no description. |
function ObjectVectorIsNilOrEmpty(const List: TBaseItems): boolean; overload; |
|
Is List nil or empty. |
Types
TVisibility = (...); |
|
Visibility of a field/method. Values
|
TVisibilities = set of TVisibility; |
|
This item has no description. |
TInfoMergeType = (...); |
|
Type of merging interface and implementation comments. See --implementation-comments documentation. Values
|
PRawDescriptionInfo = ˆTRawDescriptionInfo; |
|
This item has no description. |
THintDirective = (...); |
|
This item has no description. Values
|
THintDirectives = set of THintDirective; |
|
This item has no description. |
TRoutineType = (...); |
|
Routine type for TPasRoutine.What Values
|
TCIOType = (...); |
|
Determine type of TPasCio item, like a class or record. Values
|
TClassDirective = (...); |
|
This item has no description. Values
|
TExternalItemList = specialize TObjectList<TExternalItem>; |
|
This item has no description. |
TBaseItemDictionary = specialize TDictionary<String, TBaseItem>; |
|
This item has no description. |
TStringStringDictionary = specialize TDictionary<String, String>; |
|
This item has no description. |
Constants
VisibilityStr: array[TVisibility] of string[16] =
(
'published',
'public',
'protected',
'strict protected',
'private',
'strict private',
'automated',
'implicit'
); |
|
This item has no description. |
AllVisibilities = [Low(TVisibility) .. High(TVisibility)]; |
|
This item has no description. |
DefaultVisibilities = [Low(TVisibility) .. High(TVisibility)] -
[viPrivate, viStrictPrivate, viImplicit]; |
|
Default visibility, as documented on https://pasdoc.github.io/VisibleMembers |
InfoMergeTypeStr: array[TInfoMergeType] of string = (
'none',
'prefer-interface',
'prefer-implementation',
'join'
); |
|
This item has no description. |
CIORecordType = [CIO_RECORD, CIO_PACKEDRECORD]; |
|
This item has no description. |
CIONonHierarchy = CIORecordType; |
|
This item has no description. |
EmptyRawDescriptionInfo: TRawDescriptionInfo =
( Content: ''; StreamName: ''; BeginPosition: -1; EndPosition: -1; ); |
|
This item has no description. |
Authors
Created
11 Mar 1999
Generated by PasDoc 1.0.2.