From aa1d721ea2b96b99b8892a6d85e1dcc24e73f145 Mon Sep 17 00:00:00 2001
From: hickert <hickert@594d385d-05f5-0310-b6e9-bd551577e9d8>
Date: Wed, 7 May 2008 08:21:46 +0000
Subject: [PATCH] Added comments.

git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@10804 594d385d-05f5-0310-b6e9-bd551577e9d8
---
 .../services/kerberos/class_goKrbServer.inc   | 30 ++++++++++++++-
 .../services/kerberos/class_krb5_policy.inc   | 38 ++++++++++++++++++-
 2 files changed, 65 insertions(+), 3 deletions(-)

diff --git a/gosa-plugins/heimdal/admin/systems/services/kerberos/class_goKrbServer.inc b/gosa-plugins/heimdal/admin/systems/services/kerberos/class_goKrbServer.inc
index fda2ebb1a..e90adde6c 100644
--- a/gosa-plugins/heimdal/admin/systems/services/kerberos/class_goKrbServer.inc
+++ b/gosa-plugins/heimdal/admin/systems/services/kerberos/class_goKrbServer.inc
@@ -1,5 +1,26 @@
 <?php
+/*
+   This code is part of GOsa (https://gosa.gonicus.de)
+   Copyright (C) 2008 Fabian Hickert
 
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+
+/*! brief   The kerberos service class 
+ */
 class goKrbServer extends goService{
 	
   var $cli_summary      = "This pluign is used within the ServerService Pluign \nand indicates that this server supports NTP service.";
@@ -25,7 +46,12 @@ class goKrbServer extends goService{
   var $id               = -1;
   var $macAddress       = "" ;
 
- 
+
+  /*! \brief Initializes the kerberos service 
+      @param  Object  GOsa configuration object.
+      @param  String  The object dn we are currently editing.
+      @param  Object  The parent object.
+   */ 
   public function goKrbServer(&$config,$dn,$parent)
   {
     goService::goService($config,$dn);
@@ -56,7 +82,7 @@ class goKrbServer extends goService{
   }
 
 
-  /*! \brief Create HTML output
+  /*! \brief  Create HTML output
       @return String HMTL output.
    */
   public function execute()
diff --git a/gosa-plugins/heimdal/admin/systems/services/kerberos/class_krb5_policy.inc b/gosa-plugins/heimdal/admin/systems/services/kerberos/class_krb5_policy.inc
index e52889aea..02234d73f 100644
--- a/gosa-plugins/heimdal/admin/systems/services/kerberos/class_krb5_policy.inc
+++ b/gosa-plugins/heimdal/admin/systems/services/kerberos/class_krb5_policy.inc
@@ -1,5 +1,22 @@
 <?php
+/*
+   This code is part of GOsa (https://gosa.gonicus.de)
+   Copyright (C) 2008 Fabian Hickert
 
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
 
 class krb5_policy extends plugin
 {
@@ -12,6 +29,12 @@ class krb5_policy extends plugin
   var $attributes = array("MASK","POLICY_REFCNT","PW_HISTORY_NUM","PW_MAX_LIFE",
       "PW_MIN_CLASSES","PW_MIN_LENGTH","PW_MIN_LIFE");
 
+  
+  /*! \brief Initializes the policy class.
+      @param Object The GOsa configuration object. 
+      @param Array  The policy data array to edit or an empty array()
+      @param Object The parent object.
+   */
 	public function __construct($config,$entry,$parent)
 	{
     $this->config = $config;
@@ -32,6 +55,11 @@ class krb5_policy extends plugin
     $this->init_name = $this->name;
 	}
 
+  
+  /*! \brief  Returns a HTML ui which allows 
+                configuring this policy 
+      @return String a HTML interface.
+   */
   public function execute()
   {
     $display = plugin::execute();
@@ -45,6 +73,8 @@ class krb5_policy extends plugin
   }
 
 
+  /*! \brief  Saves the HTML posted variables 
+   */
   public function save_object()
   {
     if(isset($_POST['Policy_Posted'])){
@@ -59,7 +89,10 @@ class krb5_policy extends plugin
     }
   }
    
-  
+ 
+  /*! \brief Checks the given input 
+      @return Array   Containing errors about incorrect values.
+   */ 
   public function check()
   {
     $message = array();
@@ -120,6 +153,9 @@ class krb5_policy extends plugin
   }
    
 
+  /*! \brief  Returns object data of the currently edited policy 
+      @return Array   A multidimensional array containing policy informations.
+   */
   public function save()
   {
     $ret = array();
-- 
2.30.2