From f8a171cf9328f9443436b7d2f5eb64f48cb47adf Mon Sep 17 00:00:00 2001
From: Roland Gruber <post@rolandgruber.de>
Date: Wed, 20 Jul 2005 18:07:10 +0000
Subject: [PATCH] added basic PHPDoc comments

---
 lam/lib/export.inc              |  1 +
 lam/lib/schema.inc              | 15 +++++++++++++++
 lam/templates/login.php         | 10 ++++++++--
 lam/templates/ou_edit.php       | 12 ++++++++++--
 lam/templates/schema/schema.php | 14 ++++++--------
 5 files changed, 40 insertions(+), 12 deletions(-)

diff --git a/lam/lib/export.inc b/lam/lib/export.inc
index a1ed181b..f2c3ed3c 100755
--- a/lam/lib/export.inc
+++ b/lam/lib/export.inc
@@ -36,6 +36,7 @@ $Id$
  * @author Roland Gruber
  */ 
 
+/** used to print status messages */
 include_once('status.inc');
 
 // registry for the exporters
diff --git a/lam/lib/schema.inc b/lam/lib/schema.inc
index 886bc4a1..180688e8 100644
--- a/lam/lib/schema.inc
+++ b/lam/lib/schema.inc
@@ -25,6 +25,7 @@ $Id$
  * Classes and functions for fetching and parsing schema from an LDAP server.
  * 
  * @package lib
+ *
  * @author The phpLDAPadmin development team
  * @author Roland Gruber
  */ 
@@ -38,6 +39,8 @@ $Id$
  * All schema items have at least two things in common: An OID 
  * and a description. This class provides an implementation for 
  * these two data.
+ * 
+ * @package lib
  */
  class SchemaItem
  {
@@ -82,6 +85,8 @@ $Id$
 
 /**
  * Represents an LDAP objectClass
+ * 
+ * @package lib
  */
 class ObjectClass extends SchemaItem
 {
@@ -465,6 +470,8 @@ class ObjectClass extends SchemaItem
   * a "source" objectClass, meaning that it keeps track of which objectClass originally
   * specified it. This class is therefore used by the class ObjectClass to determine
   * inheritance.
+  * 
+  * @package lib
   */
  class ObjectClassAttribute
  {
@@ -501,6 +508,8 @@ class ObjectClass extends SchemaItem
 
 /**
  * Represents an LDAP AttributeType 
+ * 
+ * @package lib
  */
 class AttributeType extends SchemaItem
 {
@@ -954,6 +963,8 @@ class AttributeType extends SchemaItem
 
 /**
  * Represents an LDAP Syntax
+ * 
+ * @package lib
  */
 class Syntax extends SchemaItem
 {
@@ -998,6 +1009,8 @@ class Syntax extends SchemaItem
 
 /**
  * Represents an LDAP MatchingRule
+ * 
+ * @package lib
  */
 class MatchingRule extends SchemaItem
 {
@@ -1134,6 +1147,8 @@ class MatchingRule extends SchemaItem
 
 /**
  * Represents an LDAP schema matchingRuleUse entry
+ * 
+ * @package lib
  */ 
 class MatchingRuleUse extends SchemaItem
 {
diff --git a/lam/templates/login.php b/lam/templates/login.php
index f0c8c112..6f7bceeb 100644
--- a/lam/templates/login.php
+++ b/lam/templates/login.php
@@ -19,10 +19,16 @@ $Id$
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-
-  LDAP Account Manager checking login datas.
 */
 
+/**
+* Login form of LDAP Account Manager.
+*
+* @author Michael Duergner
+* @package main
+*/
+
+/** access to configuration options */
 include_once("../lib/config.inc"); // Include config.inc which provides Config class
 
 session_save_path("../sess"); // Set session save path
diff --git a/lam/templates/ou_edit.php b/lam/templates/ou_edit.php
index 40ba8f2f..549ba761 100644
--- a/lam/templates/ou_edit.php
+++ b/lam/templates/ou_edit.php
@@ -19,12 +19,20 @@ $Id$
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-  This is an editor for orgnizational units.
-
 */
 
+/**
+* This is an editor for organizational units.
+*
+* @author Roland Gruber
+* @package tools
+*/
+
+/** access to configuration data */
 include_once ("../lib/config.inc");
+/** access LDAP server */
 include_once ("../lib/ldap.inc");
+/** used to print status messages */
 include_once ("../lib/status.inc");
 
 // start session
diff --git a/lam/templates/schema/schema.php b/lam/templates/schema/schema.php
index 9afd49cb..d6465086 100644
--- a/lam/templates/schema/schema.php
+++ b/lam/templates/schema/schema.php
@@ -22,14 +22,12 @@ $Id$
 */
 
 
-/* 
- * schema.php
- * Displays the schema for the specified server_id
- * 
- * Variables that come in as GET vars:
- *  - server_id
- *  - view (optional: can be 'attr' or empty. If 'attr', show that attribute)
- *  - attr (optional)
+/**
+ * Displays the LDAP schema of the server
+ *
+ * @package tools
+ * @author David Smith
+ * @author Roland Gruber
  */