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 topic.
Name	Returns the name of the topic.
Class	Returns the class of the topic.
SetClass	Replaces the topic’s class.
Scope	Returns the scope the topic appears in.
SetScope	Replaces the topic’s scope.
Prototype	Returns the prototype if Type() is <TOPIC_FUNCTION> or <TOPIC_VARIABLE> and one is defined.
SetPrototype	Replaces the function or variable prototype.
Summary	Returns the topic summary, if it exists, formatted in NDMarkup.
Body	Returns the topic’s body, formatted in NDMarkup.
SetBody	Replaces the topic’s body, formatted in NDMarkup.
LineNumber	Returns the line the topic appears at in the file.

Implementation

Members

The object is a blessed arrayref with the following indexes.

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

Functions

New

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

Creates a new object.

Parameters

type	The type of the topic. Will be one of the <Topic Types>.
name	The name of the topic.
class	The class of the topic’s name, if any. Set to undef if global.
scope	The scope the topic’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.
summary	The summary of the topic, if any.
body	The body of the topic, formatted in NDMarkup. May be undef, as some topics may not have bodies.
lineNumber	The line number the topic appears at in the file.

Returns

The new object.

Type

sub Type

Returns the type of the topic. Will be one of <Topic Types>.

Name

sub Name

Returns the name of the topic.

Class

sub Class

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

SetClass

sub SetClass #(class)

Replaces the topic’s class.

Scope

sub Scope

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

SetScope

sub SetScope #(scope)

Replaces the topic’s scope.

Prototype

sub Prototype

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

SetPrototype

sub SetPrototype #(prototype)

Replaces the function or variable prototype.

Summary

sub Summary

Returns the topic summary, if it exists, formatted in NDMarkup.

Body

sub Body

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

SetBody

sub SetBody #(body)

Replaces the topic’s body, formatted in NDMarkup. May be undef.

LineNumber

sub LineNumber

Returns the line the topic appears at in the file.

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