PasDoc's autodoc

Class TPasItems

Description
Hierarchy
Fields
Methods
Properties

Unit

PasDoc_Items

Declaration

type TPasItems = class(TBaseItems)

Description

Container class to store a list of TPasItems.

Hierarchy

Overview

Methods

Public function FindListItem(const AName: string): TPasItem;
Public procedure CopyItems(const c: TPasItems);
Public procedure CountCIO(var c, i, o: Integer);
Public procedure RemovePrivateItems;
Public procedure SortDeep(const SortSettings: TSortSettings);
Public procedure SortOnlyInsideItems(const SortSettings: TSortSettings);
Public procedure SortShallow;
Public procedure SetFullDeclaration(PrefixName: boolean; const Suffix: string);

Properties

Public property PasItemAt[constAIndex:Integer]: TPasItem read GetPasItemAt write SetPasItemAt;

Description

Methods

Public function FindListItem(const AName: string): TPasItem;

A comfortable routine that just calls inherited and casts result to TPasItem, since every item on this list must be always TPasItem.

Public procedure CopyItems(const c: TPasItems);

Copies all Items from c to this object, not changing c at all.

Public procedure CountCIO(var c, i, o: Integer);

Counts classes, interfaces and objects within this collection.

Public procedure RemovePrivateItems;

Checks each element's Visibility field and removes all elements with a value of viPrivate.

Public procedure SortDeep(const SortSettings: TSortSettings);

This sorts all items on this list by their name, and also calls Sort(SortSettings) for each of these items. This way it sorts recursively everything in this list.

This is equivalent to doing both SortShallow and SortOnlyInsideItems.

Public procedure SortOnlyInsideItems(const SortSettings: TSortSettings);

This calls Sort(SortSettings) for each of items on the list. It does not sort the items on this list.

Public procedure SortShallow;

This sorts all items on this list by their name. Unlike SortDeep, it does not call Sort for each of these items. So "items inside items" (e.g. class methods, if this list contains TPasCio objects) remain unsorted.

Public procedure SetFullDeclaration(PrefixName: boolean; const Suffix: string);

Sets FullDeclaration of every item to

  1. Name of this item (only if PrefixName)

  2. + Suffix.

Very useful if you have a couple of items that share a common declaration in source file, e.g. variables or fields declared like 

A, B: Integer;

Properties

Public property PasItemAt[constAIndex:Integer]: TPasItem read GetPasItemAt write SetPasItemAt;
 
Generated by PasDoc 0.16.0.