Class TPasCio

Description
Hierarchy
Methods
Properties

Unit

PasDoc_Items

Declaration

type TPasCio = class(TPasType)

Description

Extends TPasItem to store all items in a class / an object, e.g. fields.

TODO: Rename to TPasStructure, most general term.

Source: source/component/PasDoc_Items.pas (line 826).

Hierarchy

Show Additional Members:

Overview

Methods

Public class function Read7BitEncodedInt(const ASource: TStream): Integer;
Public class procedure Write7BitEncodedInt(Value: Integer; const ADestination: TStream);
Public class function LoadStringFromStream(const ASource: TStream): string;
Public class procedure SaveStringToStream(const AValue: string; const ADestination: TStream);
Public class function LoadDoubleFromStream(const ASource: TStream): double;
Public class procedure SaveDoubleToStream(const AValue: double; const ADestination: TStream);
Public class function LoadIntegerFromStream(const ASource: TStream): Longint;
Public class procedure SaveIntegerToStream(const AValue: Longint; const ADestination: TStream);
Public class procedure SerializeObject(const AObject: TSerializable; const ADestination: TStream);
Public class function DeserializeObject(const ASource: TStream): TSerializable;
Public class procedure Register(const AClass: TSerializableClass);
Public procedure SerializeToFile(const AFileName: string);
Public class function DeserializeFromFile(const AFileName: string): TSerializable;
Public function RawDescriptionInfo: PRawDescriptionInfo;
Public function Signature: string; virtual;
Protected function FindNameWithinUnit(const NameParts: TNameParts): TBaseItem; virtual;
Public function FindName(const NameParts: TNameParts): TBaseItem; override;
Public function MyUnitName: String;
Public function HasDescription: Boolean;
Public function HasRawDescription: Boolean;
Public function QualifiedName: String; override;
Public function UnitRelativeQualifiedName: string; virtual;
Public procedure SetAttributes(var Value: TStringPairVector);
Public function BasePath: string; override;
Public function HasOptionalInfo: boolean; virtual;
Public function IsOverride: Boolean; virtual;
Protected procedure Serialize(const ADestination: TStream); override;
Protected procedure Deserialize(const ASource: TStream); override;
Protected procedure StoreMemberTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);
Public constructor Create; override;
Public destructor Destroy; override;
Public function FindItem(const NameParts: TNameParts): TBaseItem; override;
Public function FindItemMaybeInAncestors(const NameParts: TNameParts): TBaseItem; override;
Public function FindItemInAncestors(const NameParts: TNameParts): TPasItem;
Public procedure Sort(const SortSettings: TSortSettings); override;
Public procedure RegisterTags(TagManager: TTagManager); override;
Public function FirstAncestor: TPasItem;
Public function InheritedItem: TPasItem; override;
Public function GetInheritedItemDescriptions: TStringPairVector; override;
Public function FirstAncestorName: string;
Public function ShowVisibility: boolean;

Properties

Public property WasDeserialized: boolean read FWasDeserialized;
Public property DetailedDescription: string read FDetailedDescription write FDetailedDescription;
Public property RawDescription: string read GetRawDescription write WriteRawDescription;
Public property FullLink: string read FFullLink write FFullLink;
Public property LastMod: string read FLastMod write FLastMod;
Public property Name: string read FName write FName;
Public property Authors: TStringVector read FAuthors write SetAuthors;
Public property Created: string read FCreated;
Public property AutoLinkHereAllowed: boolean read FAutoLinkHereAllowed write FAutoLinkHereAllowed default true;
Public property AbstractDescription: string read FAbstractDescription write FAbstractDescription;
Public property AbstractDescriptionWasAutomatic: boolean read FAbstractDescriptionWasAutomatic write FAbstractDescriptionWasAutomatic;
Public property MyUnit: TPasUnit read FMyUnit write FMyUnit;
Public property MyObject: TPasCio read FMyObject write FMyObject;
Public property MyEnum: TPasEnum read FMyEnum write FMyEnum;
Public property Visibility: TVisibility read FVisibility write FVisibility;
Public property HintDirectives: THintDirectives read FHintDirectives write FHintDirectives;
Public property DeprecatedNote: string read FDeprecatedNote write FDeprecatedNote;
Public property FullDeclaration: string read FFullDeclaration write FFullDeclaration;
Public property SeeAlso: TStringPairVector read FSeeAlso;
Public property Attributes: TStringPairVector read FAttributes;
Public property Params: TStringPairVector read FParams;
Public property Raises: TStringPairVector read FRaises;
Public property SourceAbsoluteFileName: string read FSourceAbsoluteFileName write FSourceAbsoluteFileName;
Public property SourceLine: Integer read FSourceLine write FSourceLine;
Public property Ancestors: TStringPairVector read FAncestors;
Public property Cios: TPasNestedCios read FCios;
Public property ClassDirective: TClassDirective read FClassDirective write FClassDirective;
Public property Fields: TPasItems read FFields;
Public property Constants: TPasItems read FConstants;
Public property HelperTypeIdentifier: string read FHelperTypeIdentifier write FHelperTypeIdentifier;
Public property Methods: TPasRoutines read FMethods;
Public property Properties: TPasProperties read FProperties;
Public property MyType: TCIOType read FMyType write FMyType;
Public property OutputFileName: string read FOutputFileName write FOutputFileName;
Public property Types: TPasTypes read FTypes;
Public property NameWithGeneric: string read FNameWithGeneric write FNameWithGeneric;

Description

Methods

Public class function Read7BitEncodedInt(const ASource: TStream): Integer;

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 49).

Public class procedure Write7BitEncodedInt(Value: Integer; const ADestination: TStream);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 50).

Public class function LoadStringFromStream(const ASource: TStream): string;

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 52).

Public class procedure SaveStringToStream(const AValue: string; const ADestination: TStream);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 53).

Public class function LoadDoubleFromStream(const ASource: TStream): double;

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 54).

Public class procedure SaveDoubleToStream(const AValue: double; const ADestination: TStream);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 55).

Public class function LoadIntegerFromStream(const ASource: TStream): Longint;

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 56).

Public class procedure SaveIntegerToStream(const AValue: Longint; const ADestination: TStream);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 57).

Public class procedure SerializeObject(const AObject: TSerializable; const ADestination: TStream);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 60).

Public class function DeserializeObject(const ASource: TStream): TSerializable;

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 61).

Public class procedure Register(const AClass: TSerializableClass);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 62).

Public procedure SerializeToFile(const AFileName: string);

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 63).

Public class function DeserializeFromFile(const AFileName: string): TSerializable;

This item is declared in ancestor TSerializable.

Read back from file.

Exceptions raised
EInvalidCacheFileVersion
When the cached file contents are from an old pasdoc version (or invalid).

Source: source/component/PasDoc_Serialize.pas (line 67).

Public function RawDescriptionInfo: PRawDescriptionInfo;

This item is declared in ancestor TBaseItem.

Full info about RawDescription of this item, including it's filename and position.

This is intended to be initialized by parser.

This returns PRawDescriptionInfo instead of just TRawDescriptionInfo to allow natural setting of properties of this record (otherwise 

Item.RawDescriptionInfo.StreamName := 'foo';

would not work as expected) .

Source: source/component/PasDoc_Items.pas (line 296).

Public function Signature: string; virtual;

This item is declared in ancestor TBaseItem.

Just like Name but optionally with added routine parameter types, to be unique when overloading is used. For example, for routines it may be like MyMethod(String) or MyMethod(Integer).

Source: source/component/PasDoc_Items.pas (line 339).

Protected function FindNameWithinUnit(const NameParts: TNameParts): TBaseItem; virtual;

This item is declared in ancestor TPasItem.

This does the same thing as FindName but it doesn't scan other units. If this item is a unit, it searches only inside this unit, else it searches only inside MyUnit unit.

Actually FindName uses this function.

Source: source/component/PasDoc_Items.pas (line 399).

Public function FindName(const NameParts: TNameParts): TBaseItem; override;

This item is declared in ancestor TPasItem.

This item has no description. Showing description inherited from TBaseItem.FindName.

Do all you can to find link specified by NameParts.

While searching this tries to mimic ObjectPascal identifier scope as much as it can. It seaches within this item, but also within class enclosing this item, within ancestors of this class, within unit enclosing this item, then within units used by unit of this item.

Source: source/component/PasDoc_Items.pas (line 404).

Public function MyUnitName: String;

This item is declared in ancestor TPasItem.

Name MyUnit or empty string if MyUnit is nil.

Source: source/component/PasDoc_Items.pas (line 409).

Public function HasDescription: Boolean;

This item is declared in ancestor TPasItem.

Returns true if there is a DetailedDescription or AbstractDescription available.

Source: source/component/PasDoc_Items.pas (line 464).

Public function HasRawDescription: Boolean;

This item is declared in ancestor TPasItem.

Is RawDescription not empty.

Source: source/component/PasDoc_Items.pas (line 467).

Public function QualifiedName: String; override;

This item is declared in ancestor TPasItem.

This item has no description. Showing description inherited from TBaseItem.QualifiedName.

Returns the qualified name of the item. This is intended to return a concise and not ambigous name. E.g. in case of TPasItem it is overridden to return Name qualified by class name and unit name.

In this class this simply returns Name.

Source: source/component/PasDoc_Items.pas (line 469).

Public function UnitRelativeQualifiedName: string; virtual;

This item is declared in ancestor TPasItem.

This item has no description.

Source: source/component/PasDoc_Items.pas (line 470).

Public procedure SetAttributes(var Value: TStringPairVector);

This item is declared in ancestor TPasItem.

This item has no description.

Source: source/component/PasDoc_Items.pas (line 553).

Public function BasePath: string; override;

This item is declared in ancestor TPasItem.

This item has no description. Showing description inherited from TBaseItem.BasePath.

The full (absolute) path used to resolve filenames in this item's descriptions. Must always end with PathDelim. In this class, this simply returns GetCurrentDir (with PathDelim added if needed).

Source: source/component/PasDoc_Items.pas (line 567).

Public function HasOptionalInfo: boolean; virtual;

This item is declared in ancestor TPasItem.

Is optional information (that may be empty for after parsing unit and expanding tags) specified. Currently this checks Params and Raises and TPasRoutine.Returns.

Source: source/component/PasDoc_Items.pas (line 599).

Public function IsOverride: Boolean; virtual;

This item is declared in ancestor TPasItem.

Whether this item overrides an item in an ancestor.

Source: source/component/PasDoc_Items.pas (line 602).

Protected procedure Serialize(const ADestination: TStream); override;

This item has no description. Showing description inherited from TBaseItem.Serialize.

Serialization of TPasItem need to store in stream only data that is generated by parser. That's because current approach treats "loading from cache" as equivalent to parsing a unit and stores to cache right after parsing a unit. So what is generated by parser must be written to cache.

That said,

  1. It will not break anything if you will accidentally store in cache something that is not generated by parser. That's because saving to cache will be done anyway right after doing parsing, so properties not initialized by parser will have their initial values anyway. You're just wasting memory for cache, and some cache saving/loading time.

  2. For now, in implementation of serialize/deserialize we try to add even things not generated by parser in a commented out code. This way if approach to cache will change some day, we will be able to use this code.

Source: source/component/PasDoc_Items.pas (line 841).

Protected procedure Deserialize(const ASource: TStream); override;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 842).

Protected procedure StoreMemberTag(ThisTag: TTag; var ThisTagData: TObject; EnclosingTag: TTag; var EnclosingTagData: TObject; const TagParameter: string; var ReplaceStr: string);

This item has no description.

Source: source/component/PasDoc_Items.pas (line 843).

Public constructor Create; override;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 847).

Public destructor Destroy; override;

This item has no description.

Source: source/component/PasDoc_Items.pas (line 848).

Public function FindItem(const NameParts: TNameParts): TBaseItem; override;

If this class (or interface or object) contains a member with the given name, return it.

Source: source/component/PasDoc_Items.pas (line 852).

Public function FindItemMaybeInAncestors(const NameParts: TNameParts): TBaseItem; override;

This item has no description. Showing description inherited from TBaseItem.FindItemMaybeInAncestors.

This is just like FindItem, but in case of classes or such it should also search within ancestors. In this class, the default implementation just calls FindItem.

Source: source/component/PasDoc_Items.pas (line 854).

Public function FindItemInAncestors(const NameParts: TNameParts): TPasItem;

This searches for item (field, method or property) defined in ancestor of this cio. I.e. searches within the FirstAncestor, then within FirstAncestor.FirstAncestor, and so on. Returns nil if not found.

Source: source/component/PasDoc_Items.pas (line 861).

Public procedure Sort(const SortSettings: TSortSettings); override;

This item has no description. Showing description inherited from TPasItem.Sort.

Sort items inside (recursively, so it sorts within the items too). E.g. in case of TPasUnit, we can sort variables, constants, CIOs in the unit, and then we call Sort(SortSettings) for every CIO.

Only the thigns listed in SortSettings will be sorted, the rest will be left unsorted.

Note that some things are never sorted, e.g. members of TPasEnum are never sorted (since their order affects the code logic, so we should not misrepresent it in the output doc).

Source: source/component/PasDoc_Items.pas (line 863).

Public procedure RegisterTags(TagManager: TTagManager); override;

This item has no description. Showing description inherited from TBaseItem.RegisterTags.

It registers TTags that init Authors, Created, LastMod and remove relevant tags from description. You can override it to add more handlers.

Source: source/component/PasDoc_Items.pas (line 865).

Public function FirstAncestor: TPasItem;

This returns Ancestors[0].Data, i.e. instance of the first ancestor of this Cio (or nil if it couldn't be found), or nil if Ancestors.Count = 0.

Source: source/component/PasDoc_Items.pas (line 911).

Public function InheritedItem: TPasItem; override;

Get the closest item that this item inherits from. Returns the value of FirstAncestor.

Source: source/component/PasDoc_Items.pas (line 915).

Public function GetInheritedItemDescriptions: TStringPairVector; override;

This item has no description. Showing description inherited from TPasItem.GetInheritedItemDescriptions.

Generate a list of descriptions defined on this item in base classes.

This stops at the first class ancestor to have a description defined for an ancestor of this item. Along the way it will also collect descriptions of this item from any implemented interfaces.

If there is no description in any ancestor, it will return an empty vector.

Source: source/component/PasDoc_Items.pas (line 917).

Public function FirstAncestorName: string;

This returns the name of first ancestor of this Cio.

If Ancestor.Count > 0 then it simply returns Ancestors[0], i.e. the name of the first ancestor as was specified at class declaration, else it returns ''.

So this method is roughly something like FirstAncestor.Name, but with a few notable differences:

  • FirstAncestor is nil if the ancestor was not found in items parsed by pasdoc. But this method will still return in this case name of ancestor.

  • FirstAncestor.Name is the name of ancestor as specified at declaration of an ancestor. But this method is the name of ancestor as specified at declaration of this cio — with the same letter case, with optional unit specifier.

If this function returns '', then you can be sure that FirstAncestor returns nil. The other way around is not necessarily true — FirstAncestor may be nil, but still this function may return something <> ''.

Source: source/component/PasDoc_Items.pas (line 944).

Public function ShowVisibility: boolean;

Is visibility of members (public, private and so on) worth showing? This is for now just always True . In the past, for records it was False, but advanced records means that this makes sense for records too. We may remove this property in the future to simplify things, for now we keep this around in case it may make sense for some structure again.

Source: source/component/PasDoc_Items.pas (line 978).

Properties

Public property WasDeserialized: boolean read FWasDeserialized;

This item is declared in ancestor TSerializable.

This item has no description.

Source: source/component/PasDoc_Serialize.pas (line 68).

Public property DetailedDescription: string read FDetailedDescription write FDetailedDescription;

This item is declared in ancestor TBaseItem.

Detailed description of this item.

In case of TPasItem, this is something more elaborate than TPasItem.AbstractDescription.

This is already in the form suitable for final output, ready to be put inside final documentation.

Source: source/component/PasDoc_Items.pas (line 274).

Public property RawDescription: string read GetRawDescription write WriteRawDescription;

This item is declared in ancestor TBaseItem.

This stores unexpanded version (as specified in user's comment in source code of parsed units) of description of this item.

Actually, this is just a shortcut to RawDescriptionInfo.Content

Source: source/component/PasDoc_Items.pas (line 283).

Public property FullLink: string read FFullLink write FFullLink;

This item is declared in ancestor TBaseItem.

a full link that should be enough to link this item from anywhere else

Source: source/component/PasDoc_Items.pas (line 299).

Public property LastMod: string read FLastMod write FLastMod;

This item is declared in ancestor TBaseItem.

Contains '' or string with date of last modification. This string is already in the form suitable for final output format (i.e. already processed by TDocGenerator.ConvertString).

Source: source/component/PasDoc_Items.pas (line 304).

Public property Name: string read FName write FName;

This item is declared in ancestor TBaseItem.

name of the item

Source: source/component/PasDoc_Items.pas (line 307).

Public property Authors: TStringVector read FAuthors write SetAuthors;

This item is declared in ancestor TBaseItem.

list of strings, each representing one author of this item

Source: source/component/PasDoc_Items.pas (line 318).

Public property Created: string read FCreated;

This item is declared in ancestor TBaseItem.

Contains '' or string with date of creation. This string is already in the form suitable for final output format (i.e. already processed by TDocGenerator.ConvertString).

Source: source/component/PasDoc_Items.pas (line 323).

Public property AutoLinkHereAllowed: boolean read FAutoLinkHereAllowed write FAutoLinkHereAllowed default true;

This item is declared in ancestor TBaseItem.

Is auto-link mechanism allowed to create link to this item ? This may be set to False by @noAutoLinkHere tag in item's description.

Source: source/component/PasDoc_Items.pas (line 327).

Public property AbstractDescription: string read FAbstractDescription write FAbstractDescription;

This item is declared in ancestor TPasItem.

Abstract description of this item. This is intended to be short (e.g. one sentence) description of this object.

This will be inited from @abstract tag in RawDescription, or cutted out from first sentence in RawDescription if --auto-abstract was used.

Note that this is already in the form suitable for final output, with tags expanded, chars converted etc.

Source: source/component/PasDoc_Items.pas (line 421).

Public property AbstractDescriptionWasAutomatic: boolean read FAbstractDescriptionWasAutomatic write FAbstractDescriptionWasAutomatic;

This item is declared in ancestor TPasItem.

TDocGenerator.ExpandDescriptions sets this property to true if AutoAbstract was used and AbstractDescription of this item was automatically deduced from the 1st sentence of RawDescription.

Otherwise (if @abstract was specified explicitly, or there was no @abstract and AutoAbstract was false) this is set to false.

This is a useful hint for generators: it tells them that when they are printing both AbstractDescription and DetailedDescription of the item in one place (e.g. TTexDocGenerator.WriteItemLongDescription and TGenericHTMLDocGenerator.WriteItemLongDescription both do this) then they should not put any additional space between AbstractDescription and DetailedDescription.

This way when user will specify description like 

{ First sentence. Second sentence. }
procedure Foo;

and --auto-abstract was on, then "First sentence." is the AbstractDescription, " Second sentence." is DetailedDescription, AbstractDescriptionWasAutomatic is true and and TGenericHTMLDocGenerator.WriteItemLongDescription can print them as "First sentence. Second sentence."

Without this property, TGenericHTMLDocGenerator.WriteItemLongDescription would not be able to say that this abstract was deduced automatically and would print additional paragraph break that was not present in desscription, i.e. "First sentence.<p> Second sentence."

Source: source/component/PasDoc_Items.pas (line 458).

Public property MyUnit: TPasUnit read FMyUnit write FMyUnit;

This item is declared in ancestor TPasItem.

Unit of this item.

Source: source/component/PasDoc_Items.pas (line 473).

Public property MyObject: TPasCio read FMyObject write FMyObject;

This item is declared in ancestor TPasItem.

If this item is part of a class (or record, object., interface...), the corresponding class is stored here. Nil otherwise.

Source: source/component/PasDoc_Items.pas (line 477).

Public property MyEnum: TPasEnum read FMyEnum write FMyEnum;

This item is declared in ancestor TPasItem.

If this item is a member of an enumerated type, then the enclosing enumerated type is stored here. Nil otherwise.

Source: source/component/PasDoc_Items.pas (line 481).

Public property Visibility: TVisibility read FVisibility write FVisibility;

This item is declared in ancestor TPasItem.

This item has no description.

Source: source/component/PasDoc_Items.pas (line 483).

Public property HintDirectives: THintDirectives read FHintDirectives write FHintDirectives;

This item is declared in ancestor TPasItem.

Hint directives specify is this item deprecated, platform-specific, library-specific, experimental, or unimplemented.

Source: source/component/PasDoc_Items.pas (line 487).

Public property DeprecatedNote: string read FDeprecatedNote write FDeprecatedNote;

This item is declared in ancestor TPasItem.

Deprecation note, specified as a string after "deprecated" directive. Empty if none, always empty if HintDirectives does not contain hdDeprecated.

Source: source/component/PasDoc_Items.pas (line 492).

Public property FullDeclaration: string read FFullDeclaration write FFullDeclaration;

This item is declared in ancestor TPasItem.

Full declaration of the item, similar to how it appears in the Pascal source code.

Note that that this is not used for some descendants. Right now it's used only with

  • TPasConstant

  • TPasFieldVariable (includes type, default values, etc.)

  • TPasType

  • TPasRoutine (includes parameter list, procedural directives, etc.)

  • TPasProperty (includes read/write and storage specifiers, etc.)

  • TPasEnum

    But in this special case, '...' is used instead of listing individual members, e.g. 'TEnumName = (...)'. You can get list of Members using TPasEnum.Members. Eventual specifics of each member should be also specified somewhere inside Members items, e.g. 

    TMyEnum = (meOne, meTwo = 3);

    and 

    TMyEnum = (meOne, meTwo);

    will both result in TPasEnum with equal FullDeclaration (just 'TMyEnum = (...)') but this '= 3' should be marked somewhere inside Members[1] properties.

  • TPasItem when it's a CIO's field.

The intention is that in the future all TPasItem descendants will always have appropriate FullDeclaration set. It all requires adjusting appropriate places in PasDoc_Parser to generate appropriate FullDeclaration.

Source: source/component/PasDoc_Items.pas (line 543).

Public property SeeAlso: TStringPairVector read FSeeAlso;

This item is declared in ancestor TPasItem.

Items here are collected from @seealso tags.

Name of each item is the 1st part of @seealso parameter. Value is the 2nd part of @seealso parameter.

Source: source/component/PasDoc_Items.pas (line 549).

Public property Attributes: TStringPairVector read FAttributes;

This item is declared in ancestor TPasItem.

List of attributes defined for this item

Source: source/component/PasDoc_Items.pas (line 552).

Public property Params: TStringPairVector read FParams;

This item is declared in ancestor TPasItem.

Parameters of method or property.

Name of each item is the name of parameter (without any surrounding whitespace), Value of each item is users description for this item (in already-expanded form).

This is already in the form processed by TTagManager.Execute, i.e. with links resolved, html characters escaped etc. So don't convert them (e.g. before writing to the final docs) once again (by some ExpandDescription or ConvertString or anything like that).

Source: source/component/PasDoc_Items.pas (line 580).

Public property Raises: TStringPairVector read FRaises;

This item is declared in ancestor TPasItem.

Exceptions raised by the method, or by property getter/setter.

Name of each item is the name of exception class (without any surrounding whitespace), Value of each item is users description for this item (in already-expanded form).

This is already in the form processed by TTagManager.Execute, i.e. with links resolved, html characters escaped etc. So don't convert them (e.g. before writing to the final docs) once again (by some ExpandDescription or ConvertString or anything like that).

Source: source/component/PasDoc_Items.pas (line 593).

Public property SourceAbsoluteFileName: string read FSourceAbsoluteFileName write FSourceAbsoluteFileName;

This item is declared in ancestor TPasItem.

Source (absolute) file name where this item is declared. Set by the parser when parsing the item's declaration.

Source: source/component/PasDoc_Items.pas (line 606).

Public property SourceLine: Integer read FSourceLine write FSourceLine;

This item is declared in ancestor TPasItem.

Source line number (1-based) where this item is declared. Set by the parser when parsing the item's declaration.

Source: source/component/PasDoc_Items.pas (line 611).

Public property Ancestors: TStringPairVector read FAncestors;

Name of the ancestor (class, object, interface). Each item is a TStringPair, with

  • Name is the name (single Pascal identifier) of this ancestor,

  • Value is the full declaration of this ancestor. For example, in addition to Name, this may include "specialize" directive (for FPC generic specialization) at the beginning. And "<foo,bar>" section at the end (for FPC or Delphi generic specialization).

  • Data is a TPasItem reference to this ancestor, or Nil if not found. This is assigned only in TDocGenerator.BuildLinks.

Note that each ancestor is a TPasItem, not necessarily TPasCio. Consider e.g. the case 

TMyStringList = Classes.TStringList;
TMyExtendedStringList = class(TMyStringList)
  ...
end;

At least for now, such declaration will result in TPasType (not TPasCio!) with Name = 'TMyStringList', which means that ancestor of TMyExtendedStringList will be a TPasType instance.

Note that the PasDoc_Parser already takes care of correctly setting Ancestors when user didn't specify any ancestor name at cio declaration. E.g. if this cio is a class, and user didn't specify ancestor name at class declaration, and this class name is not 'TObject' (in case pasdoc parses the RTL), the Ancestors[0] will be set to 'TObject'.

Source: source/component/PasDoc_Items.pas (line 899).

Public property Cios: TPasNestedCios read FCios;

Nested classes (and records, interfaces...).

Source: source/component/PasDoc_Items.pas (line 902).

Public property ClassDirective: TClassDirective read FClassDirective write FClassDirective;

ClassDirective is used to indicate whether a class is sealed or abstract.

Source: source/component/PasDoc_Items.pas (line 905).

Public property Fields: TPasItems read FFields;

Fields inside this class.

Source: source/component/PasDoc_Items.pas (line 947).

Public property Constants: TPasItems read FConstants;

Constants inside this class.

Source: source/component/PasDoc_Items.pas (line 950).

Public property HelperTypeIdentifier: string read FHelperTypeIdentifier write FHelperTypeIdentifier;

Type for which this is a helper. That is, this is 'foo' when we have helper like "helper for foo".

Source: source/component/PasDoc_Items.pas (line 954).

Public property Methods: TPasRoutines read FMethods;

Methods inside this class.

Source: source/component/PasDoc_Items.pas (line 958).

Public property Properties: TPasProperties read FProperties;

Properties inside this class.

Source: source/component/PasDoc_Items.pas (line 961).

Public property MyType: TCIOType read FMyType write FMyType;

Which TCIOType it is: class, interface, record, object etc.

Source: source/component/PasDoc_Items.pas (line 964).

Public property OutputFileName: string read FOutputFileName write FOutputFileName;

name of documentation output file (if each class / object gets its own file, that's the case for HTML, but not for TeX)

Source: source/component/PasDoc_Items.pas (line 968).

Public property Types: TPasTypes read FTypes;

Simple nested types (that don't fall into Cios).

Source: source/component/PasDoc_Items.pas (line 981).

Public property NameWithGeneric: string read FNameWithGeneric write FNameWithGeneric;

Name, with optional "generic" directive before (for FPC generics) and generic type identifiers list "<foo,bar>" after (for FPC and Delphi generics).

Source: source/component/PasDoc_Items.pas (line 985).

Generated by PasDoc 1.0.2.