PasDoc's autodoc

Class TListItemData

Description
Hierarchy
Fields
Methods
Properties

Unit

PasDoc_Gen

Declaration

type TListItemData = class(TObject)

Description

Collected information about @xxxList item.

Hierarchy

Overview

Methods

Public constructor Create(AItemLabel, AText: string; AIndex: Integer);

Properties

Public property ItemLabel: string read FItemLabel;
Public property Text: string read FText;
Public property Index: Integer read FIndex;

Description

Methods

Public constructor Create(AItemLabel, AText: string; AIndex: Integer);
 

Properties

Public property ItemLabel: string read FItemLabel;

This is only for @definitionList: label for this list item, taken from @itemLabel. Already in the processed form. For other lists this will always be ''.

Public property Text: string read FText;

This is content of this item, taken from @item. Already in the processed form, after TDocGenerator.ConvertString etc. Ready to be included in final documentation.

Public property Index: Integer read FIndex;

Number of this item. This should be used for @orderedList. When you iterate over TListData.Items, you should be aware that Index of list item is not necessarily equal to the position of item inside TListData.Items. That's because of @itemSetNumber tag.

Normal list numbering (when no @itemSetNumber tag was used) starts from 1. Using @itemSetNumber user is able to change following item's Index.

For unordered and definition lists this is simpler: Index is always equal to the position within TListData.Items (because @itemSetNumber is not allowed there). And usually you will just ignore Index of items on unordered and definition lists.

Generated by PasDoc 0.16.0.