NaturalDocs::Topics::Type

Exporter
NaturalDocs::Topics::Type

A class storing information about a TopicType.

Summary
NaturalDocs::Topics::TypeA class storing information about a TopicType.
@EXPORT
MembersThe object is implemented as a blessed arrayref, with the following constants as its indexes.
Types
ScopeTypeThe possible values for Scope().
Functions
NewCreates and returns a new object.
NameReturns the topic name.
PluralNameReturns the topic’s plural name.
SetPluralNameReplaces the topic’s plural name.
IndexWhether the topic is indexed.
SetIndexSets whether the topic is indexed.
ScopeReturns the topic’s ScopeType.
SetScopeReplaces the topic’s ScopeType.
PageTitleIfFirstReturns whether the topic becomes the page title if it’s first in the file.
SetPageTitleIfFirstSets whether the topic becomes the page title if it’s first in the file.
BreakListsReturns whether list topics should be broken into individual topics in the output.
SetBreakListsSets whether list topics should be broken into individual topics in the output.
ClassHierarchyReturns whether the topic is part of the class hierarchy.
SetClassHierarchySets whether the topic is part of the class hierarchy.
CanGroupWithReturns whether the type can be grouped with the passed TopicType.
SetCanGroupWithSets the list of TopicTypes the type can be grouped with.

@EXPORT

our @EXPORT

Members

The object is implemented as a blessed arrayref, with the following constants as its indexes.

NAMEThe topic’s name.
PLURAL_NAMEThe topic’s plural name.
INDEXWhether the topic is indexed.
SCOPEThe topic’s ScopeType.
PAGE_TITLE_IF_FIRSTWhether the topic becomes the page title if it’s first in a file.
BREAK_LISTSWhether list topics should be broken into individual topics in the output.
CLASS_HIERARCHYWhether the topic is part of the class hierarchy.
CAN_GROUP_WITHThe existence hashref of TopicTypes the type can be grouped with.

Types

ScopeType

The possible values for Scope().

SCOPE_NORMALThe topic stays in the current scope without affecting it.
SCOPE_STARTThe topic starts a scope.
SCOPE_ENDThe topic ends a scope, returning it to global.
SCOPE_ALWAYS_GLOBALThe topic is always global, but it doesn’t affect the current scope.

Functions

New

sub New #(name,
pluralName,
index,
scope,
pageTitleIfFirst,
breakLists)

Creates and returns a new object.

Parameters

nameThe topic name.
pluralNameThe topic’s plural name.
indexWhether the topic is indexed.
scopeThe topic’s ScopeType.
pageTitleIfFirstWhether the topic becomes the page title if it’s the first one in a file.
breakListsWhether list topics should be broken into individual topics in the output.

Name

Returns the topic name.

PluralName

Returns the topic’s plural name.

SetPluralName

Replaces the topic’s plural name.

Index

Whether the topic is indexed.

SetIndex

Sets whether the topic is indexed.

Scope

Returns the topic’s ScopeType.

SetScope

Replaces the topic’s ScopeType.

PageTitleIfFirst

Returns whether the topic becomes the page title if it’s first in the file.

SetPageTitleIfFirst

Sets whether the topic becomes the page title if it’s first in the file.

BreakLists

Returns whether list topics should be broken into individual topics in the output.

SetBreakLists

Sets whether list topics should be broken into individual topics in the output.

ClassHierarchy

Returns whether the topic is part of the class hierarchy.

SetClassHierarchy

Sets whether the topic is part of the class hierarchy.

CanGroupWith

sub CanGroupWith #(TopicType type) -> bool

Returns whether the type can be grouped with the passed TopicType.

SetCanGroupWith

sub SetCanGroupWith #(TopicType[] types)

Sets the list of TopicTypes the type can be grouped with.

A string representing a topic type as defined in Topics.txt.
our @EXPORT
Returns the topic’s ScopeType.
sub New #(name,
pluralName,
index,
scope,
pageTitleIfFirst,
breakLists)
Creates and returns a new object.
The possible values for Scope().
sub CanGroupWith #(TopicType type) -> bool
Returns whether the type can be grouped with the passed TopicType.
sub SetCanGroupWith #(TopicType[] types)
Sets the list of TopicTypes the type can be grouped with.
Close