Unit PasDoc_SortSettings

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants

Description

Sorting settings types and names.

Source: source/component/PasDoc_SortSettings.pas (line 24).

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class EInvalidSortSetting  

Functions and Procedures

function SortSettingFromName(const SortSettingName: string): TSortSetting;
function SortSettingsToName(const SortSettings: TSortSettings): string;

Types

TSortSetting = (...);
TSortSettings = set of TSortSetting;

Constants

AllSortSettings: TSortSettings = [Low(TSortSetting) .. High(TSortSetting)];
SortSettingNames: array[TSortSetting] of string = ( 'structures', 'constants', 'functions', 'types', 'variables', 'uses-clauses', 'record-fields', 'non-record-fields', 'methods', 'properties' );

Description

Functions and Procedures

function SortSettingFromName(const SortSettingName: string): TSortSetting;

This item has no description.

Exceptions raised
EInvalidSortSetting
if ASortSettingName does not match (case ignored) to any SortSettingNames.

Source: source/component/PasDoc_SortSettings.pas (line 70).

function SortSettingsToName(const SortSettings: TSortSettings): string;

Comma-separated list

Source: source/component/PasDoc_SortSettings.pas (line 73).

Types

TSortSetting = (...);

This item has no description.

Values
  • ssCIOs: CIOs in a unit or nested in CIO.
  • ssConstants: Constants in a unit or nested in CIO.
  • ssFuncsProcs: Routines in a unit.
  • ssTypes: Types in a unit.
  • ssVariables: Variables in a unit.
  • ssUsesClauses: Uses clauses in a unit.
  • ssRecordFields: Fields in a CIO that is a record.
  • ssNonRecordFields: Fields in a CIO that is not a record, like in a class or interface.
  • ssMethods: Methods in a CIO.
  • ssProperties: Properties in a CIO.

Source: source/component/PasDoc_SortSettings.pas (line 35).

TSortSettings = set of TSortSetting;

This item has no description.

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

Constants

AllSortSettings: TSortSettings = [Low(TSortSetting) .. High(TSortSetting)];

This item has no description.

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

SortSettingNames: array[TSortSetting] of string = ( 'structures', 'constants', 'functions', 'types', 'variables', 'uses-clauses', 'record-fields', 'non-record-fields', 'methods', 'properties' );

Must be lowercase. Used in SortSettingsToName, SortSettingFromName.

Source: source/component/PasDoc_SortSettings.pas (line 64).

Generated by PasDoc 1.0.2.