NaturalDocs::Topics::Type

Exporter

A class storing information about a TopicType.

Summary

NaturalDocs::Topics::Type	A class storing information about a TopicType.
@EXPORT
Members	The object is implemented as a blessed arrayref, with the following constants as its indexes.
Types
ScopeType	The possible values for Scope().
Functions
New	Creates and returns a new object.
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	Returns whether the type can be grouped with the passed TopicType.
SetCanGroupWith	Sets 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.

NAME	The topic’s name.
PLURAL_NAME	The topic’s plural name.
INDEX	Whether the topic is indexed.
SCOPE	The topic’s ScopeType.
PAGE_TITLE_IF_FIRST	Whether the topic becomes the page title if it’s first in a file.
BREAK_LISTS	Whether list topics should be broken into individual topics in the output.
CLASS_HIERARCHY	Whether the topic is part of the class hierarchy.
CAN_GROUP_WITH	The existence hashref of TopicTypes the type can be grouped with.

Types

ScopeType

The possible values for Scope().

SCOPE_NORMAL	The topic stays in the current scope without affecting it.
SCOPE_START	The topic starts a scope.
SCOPE_END	The topic ends a scope, returning it to global.
SCOPE_ALWAYS_GLOBAL	The 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

name	The topic name.
pluralName	The topic’s plural name.
index	Whether the topic is indexed.
scope	The topic’s ScopeType.
pageTitleIfFirst	Whether the topic becomes the page title if it’s the first one in a file.
breakLists	Whether 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.