PasDoc's autodoc

Record TRawDescriptionInfo

Description
Hierarchy
Fields
Methods
Properties

Unit

PasDoc_Items

Declaration

type TRawDescriptionInfo = record

Description

Raw description, in other words: the contents of comment before given item. Besides the content, this also specifies filename, begin and end positions of given comment.

Overview

Fields

Public Content: string;
Public StreamName: string;
Public BeginPosition: Int64;
Public EndPosition: Int64;

Description

Fields

Public Content: string;

This is the actual content the comment.

Public StreamName: string;

StreamName is the name of the TStream from which this comment was read. Will be '' if no comment was found. It will be ' ' if the comment was somehow read from more than one stream.

Public BeginPosition: Int64;

BeginPosition is the position in the stream of the start of the comment.

Public EndPosition: Int64;

EndPosition is the position in the stream of the character immediately after the end of the comment describing the item.

Generated by PasDoc 0.16.0.