about summary refs log tree commit diff
path: root/docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm
diff options
context:
space:
mode:
authorMagnus Auvinen <magnus.auvinen@gmail.com>2008-01-17 12:56:19 +0000
committerMagnus Auvinen <magnus.auvinen@gmail.com>2008-01-17 12:56:19 +0000
commite42c493d0c294ccb0a314c8447818c8d613195df (patch)
tree27e56d9415313ddccdb1550da64ed3ef80b1dcca /docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm
parent037569c4e52f37196275dbafec670f54da249cf8 (diff)
downloadzcatch-e42c493d0c294ccb0a314c8447818c8d613195df.tar.gz
zcatch-e42c493d0c294ccb0a314c8447818c8d613195df.zip
removed olds docs
Diffstat (limited to 'docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm')
-rw-r--r--docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm157
1 files changed, 0 insertions, 157 deletions
diff --git a/docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm b/docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm
deleted file mode 100644
index 19d17229..00000000
--- a/docs/doctool/Modules/NaturalDocs/ClassHierarchy/File.pm
+++ /dev/null
@@ -1,157 +0,0 @@
-###############################################################################
-#
-#   Class: NaturalDocs::ClassHierarchy::File
-#
-###############################################################################
-#
-#   An object that stores information about what hierarchy information is present in a file.  It does not store its <FileName>; it
-#   assumes that it will be stored in a hashref where the key is the <FileName>.
-#
-###############################################################################
-
-# 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::ClassHierarchy::File;
-
-
-#
-#   Topic: Implementation
-#
-#   Since there's only one member in the class, and it's a hashref, the class is simply the hashref itself blessed as a class.
-#   The keys are the class <SymbolStrings> that are defined in the file, and the values are existence hashrefs of each class'
-#   parent <ReferenceStrings>, or undef if none.
-#
-
-
-###############################################################################
-# Group: Modification Functions
-
-
-#
-#   Function: New
-#
-#   Creates and returns a new class.
-#
-sub New
-    {
-    my ($package) = @_;
-
-    my $object = { };
-    bless $object, $package;
-
-    return $object;
-    };
-
-#
-#   Function: AddClass
-#   Adds a rew class <SymbolString> to the file.
-#
-sub AddClass #(class)
-    {
-    my ($self, $class) = @_;
-
-    if (!exists $self->{$class})
-        {  $self->{$class} = undef;  };
-    };
-
-#
-#   Function: DeleteClass
-#   Deletes a class <SymbolString> from the file.
-#
-sub DeleteClass #(class)
-    {
-    my ($self, $class) = @_;
-    delete $self->{$class};
-    };
-
-#
-#   Function: AddParentReference
-#   Adds a parent <ReferenceString> to a class <SymbolString>.
-#
-sub AddParentReference #(class, parentReference)
-    {
-    my ($self, $class, $parent) = @_;
-
-    if (!exists $self->{$class} || !defined $self->{$class})
-        {  $self->{$class} = { };  };
-
-    $self->{$class}->{$parent} = 1;
-    };
-
-#
-#   Function: DeleteParentReference
-#   Deletes a parent <ReferenceString> from a class <SymbolString>.
-#
-sub DeleteParentReference #(class, parent)
-    {
-    my ($self, $class, $parent) = @_;
-
-    if (exists $self->{$class})
-        {
-        delete $self->{$class}->{$parent};
-
-        if (!scalar keys %{$self->{$class}})
-            {  $self->{$class} = undef;  };
-        };
-    };
-
-
-
-###############################################################################
-# Group: Information Functions
-
-
-#
-#   Function: Classes
-#   Returns an array of the class <SymbolStrings> that are defined by this file, or an empty array if none.
-#
-sub Classes
-    {
-    my ($self) = @_;
-    return keys %{$self};
-    };
-
-#
-#   Function: HasClass
-#   Returns whether the file defines the passed class <SymbolString>.
-#
-sub HasClass #(class)
-    {
-    my ($self, $class) = @_;
-    return exists $self->{$class};
-    };
-
-#
-#   Function: ParentReferencesOf
-#   Returns an array of the parent <ReferenceStrings> that are defined by the class, or an empty array if none.
-#
-sub ParentReferencesOf #(class)
-    {
-    my ($self, $class) = @_;
-
-    if (!exists $self->{$class} || !defined $self->{$class})
-        {  return ( );  }
-    else
-        {  return keys %{$self->{$class}};  };
-    };
-
-#
-#   Function: HasParentReference
-#   Returns whether the file defines the passed class <SymbolString> and parent <ReferenceString>.
-#
-sub HasParentReference #(class, parent)
-    {
-    my ($self, $class, $parent) = @_;
-
-    if (!$self->HasClass($class))
-        {  return undef;  };
-
-    return exists $self->{$class}->{$parent};
-    };
-
-
-1;