commonclasses

Uses in interface

sysutils, classes, adtdarray, adtcont, adthash, adtarray

Description

Basic classes used by all units of srcdoc.

Declarations

Name

Type

Visibility

Synopsis

THandler

class

global

TTextObject

class

global

Represents an object that can be written out.

TTextObjectList

class

global

TText

class

global

Represents a consecutive sequence of characters all with the same attributes.

TNewLine

class

global

Inserts a newline.

TIndent

class

global

TLink

class

global

THeading

class

global

TParagraph

class

global

TTable

class

global

TComment

class

global

Represents a whole parsed, formatted comment.

TSection

class

global

Represents an output section.

TDocWriter

class

global

An abstract interface of a documentation writer.

TLanguageParser

class

global

Parses input files.

TCommentParser

class

global

Parses comments.

TDriver

class

global

An abstract interface of a main program 'driver'.

ESrcdocError

class

global

ENoPreviousSection

class

global

unitHeadingSize

constant

global

bigHeadingSize

constant

global

subHeadingSize

constant

global

smallHeadingSize

constant

global

srcdocVersion

constant

global

srcdocCopyright

constant

global

docwSectionSeparator

constant

global

directorySeparator

constant

global

directorySeparator

constant

global

ExtractBaseName

function

global

Extracts the basename of a file, without the path or extension.

CopyTextObject

function

global

Interprets ptr as a TTextObject and copies it.

WriteTextObjects

procedure

global

Writes out a list of TTextObject's.

TIntegerArray

type

global

TStringSet

type

global

TStack

type

global

TOption

type

global

Global options.

TOptions

type

global

TVisibilityType

type

global

TVisibilityType indicates a general visibility type regardless of the actual visibility string used to describe the visibility.

TTextAttribute

type

global

TTextAttributeSet

type

global

TSize

type

global

THandlerFunction

type

global

Driver

variable

global

This global variable should be set only by the main program and only read by other classes.

commonclasses



unitHeadingSize

Declaration

unitHeadingSize = 1;

Visibility

global

Source

commonclasses.pas on line 560

unitHeadingSize

commonclasses


bigHeadingSize

Declaration

bigHeadingSize = 2;

Visibility

global

Source

commonclasses.pas on line 561

bigHeadingSize

commonclasses


subHeadingSize

Declaration

subHeadingSize = 3;

Visibility

global

Source

commonclasses.pas on line 562

subHeadingSize

commonclasses


smallHeadingSize

Declaration

smallHeadingSize = 4;

Visibility

global

Source

commonclasses.pas on line 563

smallHeadingSize

commonclasses


srcdocVersion

Declaration

srcdocVersion = 'SrcDoc 0.1';

Visibility

global

Source

commonclasses.pas on line 564

srcdocVersion

commonclasses


srcdocCopyright

Declaration

srcdocCopyright = 'Copyright (C) 2005 by Lukasz Czajka';

Visibility

global

Source

commonclasses.pas on line 565

srcdocCopyright

commonclasses


docwSectionSeparator

Declaration

docwSectionSeparator = '@#@';

Visibility

global

Source

commonclasses.pas on line 566

docwSectionSeparator

commonclasses


directorySeparator

Declaration

directorySeparator = '\';

Visibility

global

Source

commonclasses.pas on line 568

directorySeparator

commonclasses


directorySeparator

Declaration

directorySeparator = '/';

Visibility

global

Source

commonclasses.pas on line 570

directorySeparator

commonclasses


ExtractBaseName

Declaration

function ExtractBaseName(const path : String) : String;

Visibility

global

Source

commonclasses.pas on line 552

Description

Extracts the basename of a file, without the path or extension.

ExtractBaseName

commonclasses


CopyTextObject

Declaration

function CopyTextObject(obj : TObject) : TObject;

Visibility

global

Source

commonclasses.pas on line 557

Description

Interprets ptr as a TTextObject and copies it.

CopyTextObject

commonclasses


WriteTextObjects

Declaration

procedure WriteTextObjects(textlist : TListAdt);

Visibility

global

Source

commonclasses.pas on line 555

Description

Writes out a list of TTextObject's.

WriteTextObjects

commonclasses


TIntegerArray

Declaration

TIntegerArray = array of Integer;

Visibility

global

Source

commonclasses.pas on line 32

TIntegerArray

commonclasses


TStringSet

Declaration

TStringSet = TStringHashTable;

Visibility

global

Source

commonclasses.pas on line 33

TStringSet

commonclasses


TStack

Declaration

TStack = TArray;

Visibility

global

Source

commonclasses.pas on line 34

TStack

commonclasses


TOption

Declaration

TOption =(optDependencies, optShowPrivate, optShowProtected, optShowImplementationInfo, optJoinComments, optNewParagraphBeforeJoinedComment, optMakeSynopsis, optBeautifyComments, optTableBorder, optExplicitLocalSymbols, optEmphasis, optIgnoreHandMadeSeparators, optDiscardParagraphOnHandMadeSeparators, optLinkPlurals, optVerbose, optShowWarnings, optFetchCommentsFromAncestors, optGenerateClassTree, optGenerateInterfaceTree, optGenerateSymbolIndex, optGenerateContents);

Visibility

global

Source

commonclasses.pas on line 37

Description

Global options.

TOption

commonclasses


TOptions

Declaration

TOptions = set of TOption;

Visibility

global

Source

commonclasses.pas on line 46

TOptions

commonclasses


TVisibilityType

Declaration

TVisibilityType =(vtPublic = 1, vtProtected = 2, vtPrivate = 3);

Visibility

global

Source

commonclasses.pas on line 52

Description

TVisibilityType indicates a general visibility type regardless of the actual visibility string used to describe the visibility. In this way, for instance, both 'global' and 'public' are qualified as vtPublic.

TVisibilityType

commonclasses


TTextAttribute

Declaration

TTextAttribute =(saKeyword, saLocalSymbol, saGlobalSymbol, saPreformatted, saCode, saEmphasis);

Visibility

global

Source

commonclasses.pas on line 54

TTextAttribute

commonclasses


TTextAttributeSet

Declaration

TTextAttributeSet = set of TTextAttribute;

Visibility

global

Source

commonclasses.pas on line 56

TTextAttributeSet

commonclasses


TSize

Declaration

TSize = 1..6;

Visibility

global

Source

commonclasses.pas on line 58

TSize

commonclasses


THandlerFunction

Declaration

THandlerFunction = function(const command : String) : String of object;

Visibility

global

Source

commonclasses.pas on line 61

THandlerFunction

commonclasses


Driver

Declaration

Driver : TDriver;

Visibility

global

Source

commonclasses.pas on line 577

Description

This global variable should be set only by the main program and only read by other classes. This object is automatically destroyed in the finalization of this unit.

Driver

commonclasses