diff options
| author | Magnus Auvinen <magnus.auvinen@gmail.com> | 2008-01-17 12:56:19 +0000 |
|---|---|---|
| committer | Magnus Auvinen <magnus.auvinen@gmail.com> | 2008-01-17 12:56:19 +0000 |
| commit | e42c493d0c294ccb0a314c8447818c8d613195df (patch) | |
| tree | 27e56d9415313ddccdb1550da64ed3ef80b1dcca /docs/doctool/Modules/NaturalDocs/Topics | |
| parent | 037569c4e52f37196275dbafec670f54da249cf8 (diff) | |
| download | zcatch-e42c493d0c294ccb0a314c8447818c8d613195df.tar.gz zcatch-e42c493d0c294ccb0a314c8447818c8d613195df.zip | |
removed olds docs
Diffstat (limited to 'docs/doctool/Modules/NaturalDocs/Topics')
| -rw-r--r-- | docs/doctool/Modules/NaturalDocs/Topics/Type.pm | 155 |
1 files changed, 0 insertions, 155 deletions
diff --git a/docs/doctool/Modules/NaturalDocs/Topics/Type.pm b/docs/doctool/Modules/NaturalDocs/Topics/Type.pm deleted file mode 100644 index c5558acb..00000000 --- a/docs/doctool/Modules/NaturalDocs/Topics/Type.pm +++ /dev/null @@ -1,155 +0,0 @@ -############################################################################### -# -# Package: NaturalDocs::Topics::Type -# -############################################################################### -# -# A class storing information about a <TopicType>. -# -############################################################################### - -# This file is part of Natural Docs, which is Copyright (C) 2003-2005 Greg Valure -# Natural Docs is licensed under the GPL - -use strict; -use integer; - - -package NaturalDocs::Topics::Type; - -use NaturalDocs::DefineMembers 'NAME', 'Name()', - 'PLURAL_NAME', 'PluralName()', 'SetPluralName()', - 'INDEX', 'Index()', 'SetIndex()', - 'SCOPE', 'Scope()', 'SetScope()', - 'PAGE_TITLE_IF_FIRST', 'PageTitleIfFirst()', 'SetPageTitleIfFirst()', - 'BREAK_LISTS', 'BreakLists()', 'SetBreakLists()', - 'CLASS_HIERARCHY', 'ClassHierarchy()', 'SetClassHierarchy()', - 'VARIABLE_TYPE', 'VariableType()', 'SetVariableType()', - 'CAN_GROUP_WITH'; - -# Dependency: New() depends on the order of these and that there are no parent classes. - -use base 'Exporter'; -our @EXPORT = ('SCOPE_NORMAL', 'SCOPE_START', 'SCOPE_END', 'SCOPE_ALWAYS_GLOBAL'); - -# -# Constants: 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. -# VARIABLE_TYPE - Whether the topic can be a variable type. -# CAN_GROUP_WITH - The existence hashref of <TopicTypes> the type can be grouped with. -# - - - -############################################################################### -# Group: Types - - -# -# Constants: 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. -# -use constant SCOPE_NORMAL => 1; -use constant SCOPE_START => 2; -use constant SCOPE_END => 3; -use constant SCOPE_ALWAYS_GLOBAL => 4; - - - -############################################################################### -# Group: Functions - - -# -# Function: New -# -# 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. -# -sub New #(name, pluralName, index, scope, pageTitleIfFirst, breakLists) - { - my ($self, @params) = @_; - - # Dependency: Depends on the parameter order matching the member order and that there are no parent classes. - - my $object = [ @params ]; - bless $object, $self; - - return $object; - }; - - -# -# Functions: Accessors -# -# 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. -# VariableType - Returns whether the topic can be a variable type. -# SetVariableType - Sets whether the topic can be a variable type. -# - - -# -# Function: CanGroupWith -# -# Returns whether the type can be grouped with the passed <TopicType>. -# -sub CanGroupWith #(TopicType type) -> bool - { - my ($self, $type) = @_; - return ( defined $self->[CAN_GROUP_WITH] && exists $self->[CAN_GROUP_WITH]->{$type} ); - }; - - -# -# Function: SetCanGroupWith -# -# Sets the list of <TopicTypes> the type can be grouped with. -# -sub SetCanGroupWith #(TopicType[] types) - { - my ($self, $types) = @_; - - $self->[CAN_GROUP_WITH] = { }; - - foreach my $type (@$types) - { $self->[CAN_GROUP_WITH]->{$type} = 1; }; - }; - - - -1; |