more documentation

This commit is contained in:
Roland Gruber 2008-02-03 18:46:11 +00:00
parent 7e5c281adf
commit 6b54964610
1 changed files with 14 additions and 2 deletions

View File

@ -3,7 +3,7 @@
$Id$ $Id$
This code is part of LDAP Account Manager (http://www.sourceforge.net/projects/lam) This code is part of LDAP Account Manager (http://www.sourceforge.net/projects/lam)
Copyright (C) 2003 - 2006 Roland Gruber Copyright (C) 2003 - 2008 Roland Gruber
This program is free software; you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@ -316,6 +316,17 @@ abstract class baseModule {
* <br><br> * <br><br>
* </li> * </li>
* *
* <li><b>{@link get_help()}</b><br>
* <br>
* <b>Key:</b> help<br>
* <b>Value:</b> hashtable of help entries<br>
* <br>
* The hashtable is an array which maps help IDs to help entries.<br>
* <br>
* <b>Example:</b> 'help' => array('myEntry' => array('Headline' => 'This is the head line', 'Text' => 'Help content'))
* <br><br>
* </li>
*
* <li><b>{@link getSelfServiceSearchAttributes()}</b><br> * <li><b>{@link getSelfServiceSearchAttributes()}</b><br>
* <br> * <br>
* <b>Key:</b> selfServiceSearchAttributes<br> * <b>Key:</b> selfServiceSearchAttributes<br>
@ -691,7 +702,8 @@ abstract class baseModule {
/** /**
* Returns an array containing all input columns for the file upload. * Returns an array containing all input columns for the file upload.
* *
* Syntax: * <b>Syntax:</b>
* <br>
* <br> array( * <br> array(
* <br> string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>) * <br> string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
* <br> string: description, // short descriptive name * <br> string: description, // short descriptive name