From 9ba8e6cf38da5196ed7bc878fe452952f3e10638 Mon Sep 17 00:00:00 2001
From: Magnus Auvinen <magnus.auvinen@gmail.com>
Date: Tue, 22 May 2007 15:06:55 +0000
Subject: moved docs

---
 .../Modules/NaturalDocs/Settings/BuildTarget.pm    | 91 ++++++++++++++++++++++
 1 file changed, 91 insertions(+)
 create mode 100644 docs/doctool/Modules/NaturalDocs/Settings/BuildTarget.pm

(limited to 'docs/doctool/Modules/NaturalDocs/Settings/BuildTarget.pm')

diff --git a/docs/doctool/Modules/NaturalDocs/Settings/BuildTarget.pm b/docs/doctool/Modules/NaturalDocs/Settings/BuildTarget.pm
new file mode 100644
index 00000000..8494a902
--- /dev/null
+++ b/docs/doctool/Modules/NaturalDocs/Settings/BuildTarget.pm
@@ -0,0 +1,91 @@
+###############################################################################
+#
+#   Class: NaturalDocs::Settings::BuildTarget
+#
+###############################################################################
+#
+#   A class that stores information about a build target.
+#
+#   Notes:
+#
+#       <Name()> is not used yet.  It's present because targets can be named in the settings file ("api", "apipdf", etc.) but the
+#       settings file isn't implemented yet, so just set it to undef.
+#
+###############################################################################
+
+# 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::Settings::BuildTarget;
+
+
+###############################################################################
+# Group: Implementation
+
+
+#
+#   Constants: Members
+#
+#   The class is implemented as a blessed arrayref with the members below.
+#
+#       NAME           - The name of the target.
+#       BUILDER      - The <NaturalDocs::Builder::Base>-derived object for the target's output format.
+#       DIRECTORY - The output directory of the target.
+#
+use constant NAME => 0;
+use constant BUILDER => 1;
+use constant DIRECTORY => 2;
+# New depends on the order of these constants.
+
+
+###############################################################################
+# Group: Functions
+
+#
+#   Function: New
+#
+#   Creates and returns a new object.
+#
+#   Parameters:
+#
+#       name - The name of the target.
+#       builder - The <NaturalDocs::Builder::Base>-derived object for the target's output format.
+#       directory - The directory to place the output files in.
+#
+sub New #(name, builder, directory, style)
+    {
+    my $package = shift;
+
+    # This depends on the order of the parameters matching the order of the constants.
+    my $object = [ @_ ];
+    bless $object, $package;
+
+    return $object;
+    };
+
+
+# Function: Name
+# Returns the target's name.
+sub Name
+    {  return $_[0]->[NAME];  };
+
+# Function: SetName
+# Changes the target's name.
+sub SetName #(name)
+    {  $_[0]->[NAME] = $_[1];  };
+
+# Function: Builder
+# Returns the <NaturalDocs::Builder::Base>-derived object for the target's output format.
+sub Builder
+    {  return $_[0]->[BUILDER];  };
+
+# Function: Directory
+# Returns the directory for the traget's output files.
+sub Directory
+    {  return $_[0]->[DIRECTORY];  };
+
+
+1;
-- 
cgit 1.4.1