PhpDoc fixes

lam/lib/createntlm.inc

@@ -252,6 +252,12 @@ var $sbox = array(array(array(14,  4, 13,  1,  2, 15, 11,  8,  3, 10,  6, 12,  5
 		return $this->permute($rl, $this->perm6, 64);
 	}
 
+	/**
+	 * str_to_key
+	 *
+	 * @param string $str
+	 * @return string key
+	 */
 	function str_to_key($str) {
 		$key[0] = $this->unsigned_shift_r($str[0], 1);
 		$key[1] = (($str[0]&0x01)<<6) | $this->unsigned_shift_r($str[1], 2);
@@ -267,6 +273,14 @@ var $sbox = array(array(array(14,  4, 13,  1,  2, 15, 11,  8,  3, 10,  6, 12,  5
 		return $key;
 	}
 
+	/**
+	 * smb_hash
+	 *
+	 * @param unknown_type $in
+	 * @param unknown_type $key
+	 * @param unknown_type $forw
+	 * @return unknown
+	 */
 	function smb_hash($in, $key, $forw){
 		$key2 = $this->str_to_key($key);
 	
@@ -287,6 +301,12 @@ var $sbox = array(array(array(14,  4, 13,  1,  2, 15, 11,  8,  3, 10,  6, 12,  5
 		return $out;
 	}
 
+	/**
+	 * E_P16
+	 *
+	 * @param unknown_type $in
+	 * @return unknown
+	 */
 	function E_P16($in) {
 		$p14 = array_values(unpack("C*",$in));
 		$sp8 = array(0x4b, 0x47, 0x53, 0x21, 0x40, 0x23, 0x24, 0x25);

lam/lib/modules/account.inc

@@ -204,8 +204,10 @@ class account extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*/
+	 * 
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		// user name if no posixAccount
 		$modules = $_SESSION['config']->get_AccountModules($this->get_scope());

lam/lib/modules/ieee802device.inc

@@ -86,9 +86,10 @@ class ieee802Device extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return = array();
 		// list current MACs

lam/lib/modules/inetLocalMailRecipient.inc

@@ -126,8 +126,10 @@ class inetLocalMailRecipient extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*/
+	 * 
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return = array();
 		// mail routing address

lam/lib/modules/inetOrgPerson.inc

@@ -437,13 +437,16 @@ class inetOrgPerson extends baseModule {
 		return "enabled";
 	}
 
-	/* This function returns an array with 4 entries:
+	/**
-	* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr), 'lamdaemon' => array(cmds)), DN2 .... )
+	* Returns a list of modifications which have to be made to the LDAP account.
-	* DN is the DN to change. It may be possible to change several DNs,
+	*
-	* e.g. create a new user and add him to some groups via attribute memberUid
+	* @return array list of modifications
-	* add are attributes which have to be added to ldap entry
+	* <br>This function returns an array with 3 entries:
-	* remove are attributes which have to be removed from ldap entry
+	* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
-	* lamdaemon are lamdaemon commands to modify homedir, quotas, ...
+	* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
+	* <br>"add" are attributes which have to be added to LDAP entry
+	* <br>"remove" are attributes which have to be removed from LDAP entry
+	* <br>"modify" are attributes which have to been modified in LDAP entry
 	*/
 	function save_attributes() {
 		// skip saving if account is based on another structural object class

lam/lib/modules/kolabUser.inc

@@ -257,8 +257,10 @@ class kolabUser extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*/
+	 * 
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$attrsI = $this->getAccountContainer()->getAccountModule('inetOrgPerson')->getAttributes();
 		if ($this->getAccountContainer()->isNewAccount) {

lam/lib/modules/ldapPublicKey.inc

@@ -80,8 +80,10 @@ class ldapPublicKey extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*/
+	 * 
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return = array();
 		// list current keys

lam/lib/modules/nisMailAlias.inc

@@ -124,8 +124,10 @@ class nisMailAlias extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*/
+	 * 
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return = array();
 		// alias name

lam/lib/modules/posixAccount.inc

@@ -420,7 +420,11 @@ class posixAccount extends baseModule {
 		return $return;
 	}
 
-	// Constructor
+	/**
+	* Initializes the module after it became part of an accountContainer
+	*
+	* @param string $base the name of the accountContainer object ($_SESSION[$base])
+	*/
 	function init($base) {
 		// call parent init
 		parent::init($base);
@@ -906,10 +910,11 @@ class posixAccount extends baseModule {
 		return $errors;
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	* It will output a complete html-table
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$groups = $_SESSION['cache']->findgroups(); // list of all groupnames
 		if (count($groups)==0) {
@@ -1011,6 +1016,11 @@ class posixAccount extends baseModule {
 	return $return;
 	}
 
+	/**
+	* Displays the delete homedir option for the delete page.
+	*
+	* @return meta HTML code
+	*/
 	function display_html_delete() {
 		if ($this->get_scope() == 'user' && isset($_SESSION['config']->scriptPath)) {
 			$return[] = array (

lam/lib/modules/posixGroup.inc

@@ -122,6 +122,11 @@ class posixGroup extends baseModule {
 	}
 
 
+	/**
+	* Checks if the group which should be deleted is still used as primary group.
+	*
+	* @return List of LDAP operations, same as for save_attributes()
+	*/
 	function delete_attributes() {
 		$data = $_SESSION['cache']->get_cache('gidNumber', 'posixAccount', 'user');
 		$DNs = array_keys($data);
@@ -139,10 +144,11 @@ class posixGroup extends baseModule {
 	}
 
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	* It will output a complete html-table
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return[] = array(
 			0 => array('kind' => 'text', 'text' => _("Group name").'*'),
@@ -670,13 +676,16 @@ class posixGroup extends baseModule {
 		return $errors;
 	}
 
-	/* This function returns an array with 3 entries:
+	/**
-	* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
+	* Returns a list of modifications which have to be made to the LDAP account.
-	* DN is the DN to change. It may be possible to change several DNs,
+	*
-	* e.g. create a new user and add him to some groups via attribute memberUid
+	* @return array list of modifications
-	* add are attributes which have to be added to ldap entry
+	* <br>This function returns an array with 3 entries:
-	* remove are attributes which have to be removed from ldap entry
+	* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
-	* modify are attributes which have to been modified in ldap entry
+	* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
+	* <br>"add" are attributes which have to be added to LDAP entry
+	* <br>"remove" are attributes which have to be removed from LDAP entry
+	* <br>"modify" are attributes which have to been modified in LDAP entry
 	*/
 	function save_attributes() {
 		// skip saving if account is based on another structural object class

lam/lib/modules/quota.inc

@@ -180,6 +180,12 @@ class quota extends baseModule {
 		}
 	}
 
+	/**
+	* This function is used to check if this module page can be displayed.
+	* It returns false if a module depends on data from other modules which was not yet entered.
+	*
+	* @return boolean true, if page can be displayed
+	*/
 	function module_ready() {
 		if ($this->get_scope()=='user') {
 			$attrs = $this->getAccountContainer()->getAccountModule('posixAccount')->getAttributes();
@@ -192,14 +198,6 @@ class quota extends baseModule {
 		return true;
 	}
 
-	/* This functions return true
-	* if all needed settings are done
-	*/
-	function module_complete() {
-		if (!$this->module_ready()) return false;
-		return true;
-	}
-
 	/**
 	 * Allows the module to run commands after the LDAP entry is changed or created.
 	 *
@@ -327,10 +325,11 @@ class quota extends baseModule {
 		return $errors;
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	* It will output a complete html-table
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return = array();
 		$this->initQuotas();

lam/lib/modules/sambaAccount.inc

@@ -435,6 +435,12 @@ class sambaAccount extends baseModule {
 	/** Array of well known rids */
 	private $rids;
 
+	/**
+	* This function is used to check if this module page can be displayed.
+	* It returns false if a module depends on data from other modules which was not yet entered.
+	*
+	* @return boolean true, if page can be displayed
+	*/
 	function module_ready() {
 		$attrs = $this->getAccountContainer()->getAccountModule('posixAccount')->getAttributes();
 		if ($attrs['gidNumber'][0]=='') return false;
@@ -453,8 +459,10 @@ class sambaAccount extends baseModule {
 		return true;
 	}
 
-	/* This function loads all attributes into the object
+	/**
-	* $attr is an array as it's retured from ldap_get_attributes
+	* This function loads the LDAP attributes for this module.
+	*
+	* @param array $attributes attribute list
 	*/
 	function load_attributes($attr) {
 		parent::load_attributes($attr);
@@ -468,13 +476,16 @@ class sambaAccount extends baseModule {
 		}
 	}
 
-	/* This function returns an array with 3 entries:
+	/**
-	* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
+	* Returns a list of modifications which have to be made to the LDAP account.
-	* DN is the DN to change. It may be possible to change several DNs,
+	*
-	* e.g. create a new user and add him to some groups via attribute memberUid
+	* @return array list of modifications
-	* add are attributes which have to be added to ldap entry
+	* <br>This function returns an array with 3 entries:
-	* remove are attributes which have to be removed from ldap entry
+	* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
-	* modify are attributes which have to been modified in ldap entry
+	* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
+	* <br>"add" are attributes which have to be added to LDAP entry
+	* <br>"remove" are attributes which have to be removed from LDAP entry
+	* <br>"modify" are attributes which have to been modified in LDAP entry
 	*/
 	function save_attributes() {
 		/* Create sambaSID. Can't create it while loading attributes because
@@ -703,10 +714,11 @@ class sambaAccount extends baseModule {
 		return array();
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	* It will output a complete html-table
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return[] = array(
 			0 => array('kind' => 'text', 'text' => _('Display name')),
@@ -832,9 +844,10 @@ class sambaAccount extends baseModule {
 		return $return;
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	* This function will create the HTML page to edit the allowed workstations.
-	* It will output a complete html-table
+	*
+	* @return array meta HTML code
 	*/
 	function display_html_userWorkstations() {
 		if ($this->get_scope()=='user') {

lam/lib/modules/sambaDomain.inc

@@ -202,8 +202,10 @@ class sambaDomain extends baseModule {
 	}
 
 	/**
-	* This function will create the meta HTML code to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	*/
+	 * 
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$return = array();
 		// domain name

lam/lib/modules/sambaGroupMapping.inc

@@ -163,10 +163,11 @@ class sambaGroupMapping extends baseModule {
 		return $errors;
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	* It will output a complete html-table
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		$sambaDomains = search_domains();
 		if (sizeof($sambaDomains) == 0) {
@@ -383,8 +384,10 @@ class sambaGroupMapping extends baseModule {
 	}
 
 
-	/* This functions return true
+	/**
-	* if all needed settings are done
+	* This functions is used to check if all settings for this module have been made.
+	*
+	* @return boolean true, if settings are complete
 	*/
 	function module_complete() {
 		if (!$this->module_ready()) return false;
@@ -394,6 +397,12 @@ class sambaGroupMapping extends baseModule {
 	}
 
 
+	/**
+	* This function is used to check if this module page can be displayed.
+	* It returns false if a module depends on data from other modules which was not yet entered.
+	*
+	* @return boolean true, if page can be displayed
+	*/
 	function module_ready() {
 		$attrs = $this->getAccountContainer()->getAccountModule('posixGroup')->getAttributes();
 		if ($attrs['gidNumber'][0]=='') return false;
@@ -453,13 +462,16 @@ class sambaGroupMapping extends baseModule {
 	}
 
 
-	/* This function returns an array with 3 entries:
+	/**
-	* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
+	* Returns a list of modifications which have to be made to the LDAP account.
-	* DN is the DN to change. It may be possible to change several DNs,
+	*
-	* e.g. create a new user and add him to some groups via attribute memberUid
+	* @return array list of modifications
-	* add are attributes which have to be added to ldap entry
+	* <br>This function returns an array with 3 entries:
-	* remove are attributes which have to be removed from ldap entry
+	* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
-	* modify are attributes which have to been modified in ldap entry
+	* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
+	* <br>"add" are attributes which have to be added to LDAP entry
+	* <br>"remove" are attributes which have to be removed from LDAP entry
+	* <br>"modify" are attributes which have to been modified in LDAP entry
 	*/
 	function save_attributes() {
 		// Get Domain SID from name

lam/lib/modules/sambaSamAccount.inc

@@ -544,8 +544,10 @@ class sambaSamAccount extends baseModule {
 		return true;
 	}
 
-	/* This function loads all attributes into the object
+	/**
-	* $attr is an array as it's retured from ldap_get_attributes
+	* This function loads the LDAP attributes for this module.
+	*
+	* @param array $attributes attribute list
 	*/
 	function load_attributes($attr) {
 		parent::load_attributes($attr);
@@ -569,13 +571,16 @@ class sambaSamAccount extends baseModule {
 		}
 	}
 
-	/* This function returns an array with 3 entries:
+	/**
-	* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
+	* Returns a list of modifications which have to be made to the LDAP account.
-	* DN is the DN to change. It may be possible to change several DNs,
+	*
-	* e.g. create a new user and add him to some groups via attribute memberUid
+	* @return array list of modifications
-	* add are attributes which have to be added to ldap entry
+	* <br>This function returns an array with 3 entries:
-	* remove are attributes which have to be removed from ldap entry
+	* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
-	* modify are attributes which have to been modified in ldap entry
+	* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
+	* <br>"add" are attributes which have to be added to LDAP entry
+	* <br>"remove" are attributes which have to be removed from LDAP entry
+	* <br>"modify" are attributes which have to been modified in LDAP entry
 	*/
 	function save_attributes() {
 		if (!in_array('sambaSamAccount', $this->attributes['objectClass'])) {
@@ -925,10 +930,11 @@ class sambaSamAccount extends baseModule {
 		return array();
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	 * Returns the HTML meta data for the main account page.
-	* It will output a complete html-table
+	 * 
-	*/
+	 * @return array HTML meta data
+	 */
 	function display_html_attributes() {
 		if (isset($_POST['form_subpage_sambaSamAccount_attributes_addObjectClass'])) {
 			$this->attributes['objectClass'][] = 'sambaSamAccount';
@@ -1164,9 +1170,10 @@ class sambaSamAccount extends baseModule {
 		return $return;
 	}
 
-	/* This function will create the html-page
+	/**
-	* to show a page with all attributes.
+	* This function will create the HTML page to edit the allowed workstations.
-	* It will output a complete html-table
+	*
+	* @return array meta HTML code
 	*/
 	function display_html_sambaUserWorkstations() {
 		if ($this->get_scope()=='user') {

lam/lib/modules/sambaSamAccount/sambaMungedDial.inc

@@ -93,6 +93,7 @@ class sambaMungedDial
 
   private $old_behavior= false;
 
+  /** strhex */
   function strhex($string)
   {
   	$hex="";
@@ -104,6 +105,7 @@ class sambaMungedDial
   	return ($hex);
   }
 
+  /** hexstr */
   function hexstr($hex)
   {
   	$string="";
@@ -115,11 +117,13 @@ class sambaMungedDial
   	return ($string);
   }
 
+  /** endian */
   function endian($src)
   {
   	return (substr($src, 2, 2).substr($src, 0, 2));
   }
 
+  /** genTime */
   function genTime ($minutes)
   {
   	$usec= (int) ($minutes * 60 * 1000);
@@ -127,6 +131,7 @@ class sambaMungedDial
   	return (sambaMungedDial::endian(substr($src, 0, 4)).sambaMungedDial::endian(substr($src, 4, 4)));
   }
 
+  /** readTime */
   function readTime ($time)
   {
   	$lo= substr($time, 0, 4);
@@ -138,6 +143,7 @@ class sambaMungedDial
   	return ((int)($usecs / (60 * 1000)));
   }
 
+  /** to8bit */
   function to8bit($string)
   {
   	$result= "";
@@ -152,6 +158,7 @@ class sambaMungedDial
   	return ($result);
   }
 
+  /** Checks if this is a valid Samba path. */
   function is_samba_path($path)
   {
   	if ($path == ""){
@@ -165,7 +172,7 @@ class sambaMungedDial
   	return preg_match ("/\\\\.+$/", $path);
   }
 
-  /* Encode full MungedDial-String */
+  /** Encode full MungedDial-String */
   function encode_munged ($params)
   {
   	/* Walk through the parameters and convert them */
@@ -201,7 +208,7 @@ class sambaMungedDial
   	return ($result);
   }
 
-  /* Setup parameter given by paramName to MungedDial-Format */
+  /** Setup parameter given by paramName to MungedDial-Format */
   function munge($paramName, $paramValue, $isString) 
   {
   	$result= "";
@@ -239,7 +246,7 @@ class sambaMungedDial
   	return ($result);
   }
 
-  /* Takes a base64-encoded MungedDial-String and returns an array of included parameters and values */
+  /** Takes a base64-encoded MungedDial-String and returns an array of included parameters and values */
   function decode_munged($munge)
   {
   	$result= array();
@@ -294,13 +301,13 @@ class sambaMungedDial
   	return ($result);
   }
 
-  /* function takes a base64-encoded sambaMungedDial */
+  /** function takes a base64-encoded sambaMungedDial */
   function load ($mungedDial)
   {
   	$this->ctx= $this->decode_munged($mungedDial);
   }
 
-  /* Returns ready-to-run mungedDialString to be filled into ldap */
+  /** Returns ready-to-run mungedDialString to be filled into ldap */
   function getMunged ()
   {
   	// Do extra check for valid timeParams (they must be set to 0 if disabled)
@@ -314,7 +321,7 @@ class sambaMungedDial
     return $result;
   }
 
-  /* Returns array of flags, which can be set on-demand with activated java-script */
+  /** Returns array of flags, which can be set on-demand with activated java-script */
   function getOnDemandFlags ()
   {
   	$result= array();
@@ -344,7 +351,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /*Gets Terminal-Server-Login value: enabled/disabled */
+  /** Gets Terminal-Server-Login value: enabled/disabled */
   function getTsLogin ()
   {
    	$flags= ord(substr($this->ctx['CtxCfgFlags1'], 5, 1));
@@ -358,7 +365,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* Sets Terminal-Server-Login value: enabled/disabled */
+  /** Sets Terminal-Server-Login value: enabled/disabled */
   function setTsLogin ($checked)
   {
   	$flag= substr($this->ctx['CtxCfgFlags1'], 5, 1);
@@ -372,7 +379,7 @@ class sambaMungedDial
   	$this->ctx['CtxCfgFlags1'][5]= sprintf('%1x', $flag);
   }
 
-  /* gets Broken-Connection value: disconnect/reset */
+  /** gets Broken-Connection value: disconnect/reset */
   function getBrokenConn ()
   {
   	$flags= ord(substr($this->ctx['CtxCfgFlags1'], 5, 1));
@@ -385,7 +392,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets Broken-Connection value: disconnect/reset */
+  /** sets Broken-Connection value: disconnect/reset */
   function setBrokenConn ($checked) 
   {
   	$flag= substr($this->ctx['CtxCfgFlags1'], 5, 1);
@@ -399,7 +406,7 @@ class sambaMungedDial
   	$this->ctx['CtxCfgFlags1'][5]= sprintf('%1x', $flag);
   }
 
-  /* gets Reconnection value: from any client/from previous client only */
+  /** gets Reconnection value: from any client/from previous client only */
   function getReConn ()
   {
   	$flags= ord(substr($this->ctx['CtxCfgFlags1'], 5, 1));
@@ -412,7 +419,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets Reconnection value: from any client/from previous client only */
+  /** sets Reconnection value: from any client/from previous client only */
   function setReConn ($checked)
   {
   	$flag= substr($this->ctx['CtxCfgFlags1'], 5, 1);
@@ -426,7 +433,7 @@ class sambaMungedDial
   	$this->ctx['CtxCfgFlags1'][5]= sprintf('%1x', $flag);
   }
 
-  /* gets Inherit-config-from-client value: enabled/disabled */
+  /** gets Inherit-config-from-client value: enabled/disabled */
   function getInheritMode ()
   {
   	if (substr($this->ctx['CtxCfgFlags1'], 6, 1) == "1") {
@@ -438,7 +445,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets Inherit-config-from-client value: enabled/disabled */
+  /** sets Inherit-config-from-client value: enabled/disabled */
   function setInheritMode ($checked)
   {
   	if ($checked) {
@@ -448,7 +455,7 @@ class sambaMungedDial
   	}
   }
 
-  /* gets shadow value (enum): 0-4
+  /** gets shadow value (enum): 0-4
 	0: disabled
 	1: input on, notify on
 	2: input on, notify off
@@ -465,7 +472,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets shadow value */
+  /** sets shadow value */
   function setShadow ($checked, $value)
   {
   	if ($checked) {
@@ -477,7 +484,7 @@ class sambaMungedDial
   	}
   }
 
-  /* gets connect-client-drive-at-logon value: enabled/disabled */
+  /** gets connect-client-drive-at-logon value: enabled/disabled */
   function getConnectClientDrives ()
   {
   	$connections= hexdec(substr($this->ctx['CtxCfgFlags1'], 2, 1));
@@ -490,7 +497,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets connect-client-drive-at-logon value: enabled/disabled */
+  /** sets connect-client-drive-at-logon value: enabled/disabled */
   function setConnectClientDrives ($checked)
   {
   	$flag= hexdec(substr($this->ctx['CtxCfgFlags1'], 2, 1));
@@ -503,7 +510,7 @@ class sambaMungedDial
   	$this->ctx['CtxCfgFlags1'][2]= sprintf('%1x', $flag);
   }
 
-  /* gets connect-client-printers-at-logon value: enabled/disabled */
+  /** gets connect-client-printers-at-logon value: enabled/disabled */
   function getConnectClientPrinters ()
   {
   	$connections= hexdec(substr($this->ctx['CtxCfgFlags1'], 2, 1));
@@ -516,7 +523,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets connect-client-printers-at-logon value: enabled/disabled */
+  /** sets connect-client-printers-at-logon value: enabled/disabled */
   function setConnectClientPrinters ($checked)
   {
   	$flag= hexdec(substr($this->ctx['CtxCfgFlags1'], 2, 1));
@@ -530,7 +537,7 @@ class sambaMungedDial
   	$this->ctx['CtxCfgFlags1'][2]= sprintf('%1x', $flag);
   }
 
-  /* gets set-client-printer-to-default value: enabled/disabled */
+  /** gets set-client-printer-to-default value: enabled/disabled */
   function getDefaultPrinter ()
   {
   	$connections= hexdec(substr($this->ctx['CtxCfgFlags1'], 2, 1));
@@ -543,7 +550,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* sets set-client-printer-to-default value: enabled/disabled */
+  /** sets set-client-printer-to-default value: enabled/disabled */
   function setDefaultPrinter ($checked)
   {
   	$flag= hexdec(substr($this->ctx['CtxCfgFlags1'], 2, 1));
@@ -557,7 +564,7 @@ class sambaMungedDial
   	$this->ctx['CtxCfgFlags1'][2]= sprintf('%1x', $flag);
   }
 
-  /* SMARTY: gets the checkbox state of "Connection" */
+  /** SMARTY: gets the checkbox state of "Connection" */
   function getCtxMaxConnectionTimeF ()
   {
   	// Connection Time is 0 if disabled
@@ -570,7 +577,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* SMARTY: sets the checkbox "Connection" to unchecked */
+  /** SMARTY: sets the checkbox "Connection" to unchecked */
   function setCtxMaxConnectionTimeF ($checked)
   {
   	if ($checked) {
@@ -578,7 +585,7 @@ class sambaMungedDial
   	}
   }
 
-  /* SMARTY: gets the checkbox state of "Disconnection" */
+  /** SMARTY: gets the checkbox state of "Disconnection" */
   function getCtxMaxDisconnectionTimeF ()
   {
   	// Connection Time is 0 if disabled
@@ -591,7 +598,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* SMARTY: sets the checkbox "Disconnection" to unchecked */
+  /** SMARTY: sets the checkbox "Disconnection" to unchecked */
   function setCtxMaxDisconnectionTimeF ($checked)
   {
   	if ($checked) {
@@ -599,7 +606,7 @@ class sambaMungedDial
   	} 
   }
 
-  /* SMARTY: gets the checkbox state of "Idle" */
+  /** SMARTY: gets the checkbox state of "Idle" */
   function getCtxMaxIdleTimeF ()
   {
   	// Connection Time is 0 if disabled
@@ -612,7 +619,7 @@ class sambaMungedDial
   	return $result;
   }
 
-  /* SMARTY: sets the checkbox "Idle" to unchecked */
+  /** SMARTY: sets the checkbox "Idle" to unchecked */
   function setCtxMaxIdleTimeF ($checked)
   {
   	if ($checked) {