PHPDoc update

lam/lib/baseModule.inc

@@ -813,7 +813,7 @@ abstract class baseModule {
 	* Returns the PDF entries for this module.
 	*
 	* @param array $pdfKeys list of PDF keys that are included in document
-	* @return array list of possible PDF entries
+	* @return PDFEntry[] list of key => PDFEntry
 	*/
 	public function get_pdfEntries($pdfKeys) {
 		return array();

lam/lib/modules.inc

@@ -2006,7 +2006,7 @@ class accountContainer {
 	 * Returns a list of possible PDF entries for this account.
 	 *
 	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * @return PDFEntry[] list of key => PDFEntry
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/account.inc

@@ -220,10 +220,8 @@ class account extends baseModule {
 	}
 
 	/**
-	* Returns the PDF entries for this module.
-	*
-	* @param array $pdfKeys list of PDF keys that are included in document
-	* @return array list of possible PDF entries
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/asteriskAccount.inc

@@ -975,10 +975,8 @@ class asteriskAccount extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/asteriskExtension.inc

@@ -797,10 +797,8 @@ class asteriskExtension extends baseModule {
     }
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
     function get_pdfEntries($pdfKeys) {
     	$a = $this->attributes;

lam/lib/modules/asteriskVoicemail.inc

@@ -362,10 +362,8 @@ class asteriskVoicemail extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/authorizedServiceObject.inc

@@ -221,10 +221,8 @@ class authorizedServiceObject extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/ddns.inc

@@ -403,10 +403,8 @@ class ddns extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	public function get_pdfEntries($pdfKeys) {
 		// attributes are taken from DHCP server object

lam/lib/modules/dhcp_settings.inc

@@ -657,10 +657,8 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$nodeType = $this->getDHCPOption('netbios-node-type');

lam/lib/modules/eduPerson.inc

@@ -548,10 +548,8 @@ class eduPerson extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/fixed_ip.inc

@@ -731,10 +731,8 @@ class fixed_ip extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/freeRadius.inc

@@ -685,10 +685,8 @@ class freeRadius extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/hostObject.inc

@@ -195,10 +195,8 @@ class hostObject extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/ieee802device.inc

@@ -155,10 +155,8 @@ class ieee802device extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/inetLocalMailRecipient.inc

@@ -344,10 +344,8 @@ class inetLocalMailRecipient extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/inetOrgPerson.inc

@@ -1970,10 +1970,8 @@ class inetOrgPerson extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/kolabGroup.inc

@@ -390,10 +390,8 @@ class kolabGroup extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/kolabSharedFolder.inc

@@ -510,10 +510,8 @@ class kolabSharedFolder extends baseModule { // TODO folder type
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/kolabUser.inc

@@ -699,10 +699,8 @@ class kolabUser extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/ldapPublicKey.inc

@@ -282,10 +282,8 @@ class ldapPublicKey extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/nisMailAlias.inc

@@ -465,10 +465,8 @@ class nisMailAlias extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/nisMailAliasUser.inc

@@ -521,10 +521,8 @@ class nisMailAliasUser extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/nisNetGroupHost.inc

@@ -252,10 +252,8 @@ class nisNetGroupHost extends nisNetGroupUser {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/nisNetGroupUser.inc

@@ -470,10 +470,8 @@ class nisNetGroupUser extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/nisnetgroup.inc

@@ -572,10 +572,8 @@ class nisnetgroup extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/posixAccount.inc

@@ -1826,10 +1826,8 @@ class posixAccount extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$uidLabel = _('User name');

lam/lib/modules/posixGroup.inc

@@ -613,10 +613,8 @@ class posixGroup extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/puppetClient.inc

@@ -398,10 +398,8 @@ class puppetClient extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/pykotaBillingCode.inc

@@ -253,10 +253,8 @@ class pykotaBillingCode extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/pykotaGroup.inc

@@ -459,10 +459,8 @@ class pykotaGroup extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/pykotaPrinter.inc

@@ -576,10 +576,8 @@ class pykotaPrinter extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/pykotaUser.inc

@@ -884,10 +884,8 @@ class pykotaUser extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/quota.inc

@@ -611,10 +611,8 @@ class quota extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$this->initQuotas();

lam/lib/modules/range.inc

@@ -764,10 +764,8 @@ class range extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/sambaDomain.inc

@@ -590,10 +590,8 @@ class sambaDomain extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/sambaGroupMapping.inc

@@ -529,10 +529,8 @@ class sambaGroupMapping extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/sambaSamAccount.inc

@@ -1904,10 +1904,8 @@ class sambaSamAccount extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/shadowAccount.inc

@@ -547,10 +547,8 @@ class shadowAccount extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	function get_pdfEntries($pdfKeys) {
 		$timeZone = getTimeZone();

lam/lib/modules/systemQuotas.inc

@@ -376,10 +376,8 @@ class systemQuotas extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	public function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/windowsGroup.inc

@@ -904,10 +904,8 @@ class windowsGroup extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	public function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/windowsHost.inc

@@ -281,10 +281,8 @@ class windowsHost extends baseModule {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	public function get_pdfEntries($pdfKeys) {
 		$return = array();

lam/lib/modules/windowsUser.inc

@@ -2415,10 +2415,8 @@ class windowsUser extends baseModule implements passwordService {
 	}
 
 	/**
-	 * Returns a list of possible PDF entries for this account.
-	 *
-	 * @param array $pdfKeys list of PDF keys that are included in document
-	 * @return list of PDF entries (array(<PDF key> => <PDF lines>))
+	 * {@inheritDoc}
+	 * @see baseModule::get_pdfEntries()
 	 */
 	public function get_pdfEntries($pdfKeys) {
 		$return = array();