about summary refs log tree commit diff
path: root/docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm
diff options
context:
space:
mode:
authorMagnus Auvinen <magnus.auvinen@gmail.com>2008-08-02 08:21:29 +0000
committerMagnus Auvinen <magnus.auvinen@gmail.com>2008-08-02 08:21:29 +0000
commit61bfe2d70cae6be8c4086a210a5451135ccca9ea (patch)
tree62bf7808b1b2bfe5f56fe1e329871fb0991d0687 /docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm
parenta13b94f9e0bca8ea892311d9d9e0c0bc48616ea7 (diff)
downloadzcatch-61bfe2d70cae6be8c4086a210a5451135ccca9ea.tar.gz
zcatch-61bfe2d70cae6be8c4086a210a5451135ccca9ea.zip
added doc tool
Diffstat (limited to 'docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm')
-rw-r--r--docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm b/docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm
new file mode 100644
index 00000000..10d0a96b
--- /dev/null
+++ b/docs/tool/Modules/NaturalDocs/ImageReferenceTable/Reference.pm
@@ -0,0 +1,44 @@
+###############################################################################
+#
+#   Package: NaturalDocs::ImageReferenceTable::Reference
+#
+###############################################################################
+#
+#   A class for references being tracked in <NaturalDocs::SourceDB>.
+#
+###############################################################################
+
+# This file is part of Natural Docs, which is Copyright (C) 2003-2008 Greg Valure
+# Natural Docs is licensed under the GPL
+
+use strict;
+use integer;
+
+
+package NaturalDocs::ImageReferenceTable::Reference;
+
+use base 'NaturalDocs::SourceDB::Item';
+
+
+use NaturalDocs::DefineMembers 'TARGET', 'Target()', 'SetTarget()',
+                                                 'NEEDS_REBUILD', 'NeedsRebuild()', 'SetNeedsRebuild()';
+
+
+#
+#   Variables: Members
+#
+#   The following constants are indexes into the object array.
+#
+#   TARGET - The image <FileName> this reference resolves to, or undef if none.
+#
+
+
+#
+#   Functions: Member Functions
+#
+#   Target - Returns the image <FileName> this reference resolves to, or undef if none.
+#   SetTarget - Replaces the image <FileName> this reference resolves to, or undef if none.
+#
+
+
+1;