NaturalDocs:: Parser:: ParsedTopic

A class for parsed topics of source files.

Summary

NaturalDocs:: Parser:: ParsedTopic	A class for parsed topics of source files.
Implementation
Members	The object is a blessed arrayref with the following indexes.
Functions
New	Creates a new object.
Type	Returns the type of the section.
Name	Returns the name of the section.
Class	Returns the class of the section.
Scope	Returns the scope the section appears in.
Prototype	Returns the function prototype, if Type() is TOPIC_FUNCTION or TOPIC_VARIABLE and one is defined.
Body	Returns the section’s body, formatted in NDMarkup.

The object is a blessed arrayref with the following indexes.

TYPE	The type of the section. Will be one of the Topic Types.
NAME	The name of the section.
CLASS	The class of the section, if any. This applies to Name only. Will be undef if global.
SCOPE	The scope the section’s body appears in. This may be different from Class. Will be undef if global.
PROTOTYPE	The prototype, if it exists and is applicable.
BODY	The body of the section, formatted in NDMarkup. Some sections may not have bodies, and if not, this will be undef.

sub New #(type, name, class, scope, prototype, body)

Creates a new object.

type	The type of the section. Will be one of the Topic Types.
name	The name of the section.
class	The class of the section’s name, if any. Set to undef if global.
scope	The scope the section’s body appears in. This may be different from class. Set to undef if global.
prototype	If the type is TOPIC_FUNCTION or TOPIC_VARIABLE, the prototype, if it exists. Otherwise set to undef.
body	The body of the section, formatted in NDMarkup. May be undef, as some sections may not have bodies.

The new object.

sub Type

Returns the type of the section. Will be one of Topic Types.

sub Name

Returns the name of the section.

sub Class

Returns the class of the section. Applies to Name() only. Will be undef if global.

sub Scope

Returns the scope the section appears in. Applies to Body() only. Will be undef if global.

sub Prototype

Returns the function prototype, if Type() is TOPIC_FUNCTION or TOPIC_VARIABLE and one is defined. Will be undef otherwise.

sub Body

Returns the section’s body, formatted in NDMarkup. May be undef.