diff --git a/include/class_SnapShotDialog.inc b/include/class_SnapShotDialog.inc index 50797f807c7b6da0b1261485a4c6714fa536d389..9020bff51beb3046a03bec63b17f7c76f5531302 100644 --- a/include/class_SnapShotDialog.inc +++ b/include/class_SnapShotDialog.inc @@ -20,9 +20,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is the Snapshot dialog class - * - * This class contains all the function needed to make dialogs +/*! \brief This class contains all the function needed to make dialogs * for the snapshot functionality */ class SnapShotDialog extends plugin diff --git a/include/class_SnapshotHandler.inc b/include/class_SnapshotHandler.inc index 493b61287caaa5686c561b67472bbd0785ab9048..e09b9accd01838cb2aa837d066c719a9b1fc6b92 100644 --- a/include/class_SnapshotHandler.inc +++ b/include/class_SnapshotHandler.inc @@ -20,9 +20,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is the Snapshot Handler class - * - * This class contains all the function needed to handle +/*! \brief This class contains all the function needed to handle * the snapshot functionality */ class SnapshotHandler { diff --git a/include/class_acl.inc b/include/class_acl.inc index e67ad56129eb9564551b5cd4e9c05f4330089e8a..be8e023645b1b87e2c474e5e5f6fb429845d1723 100644 --- a/include/class_acl.inc +++ b/include/class_acl.inc @@ -20,7 +20,9 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief ACL management plugin */ +/*! \brief This class contains all the function needed to manage acl + * + */ class acl extends plugin { /* Definitions */ diff --git a/include/class_ldap.inc b/include/class_ldap.inc index 0478a46155b5bd08768659d54b0b040f4afa0fae..a0ca0159a0f1a54f14a99acc7b32e13c2ac7c3d1 100644 --- a/include/class_ldap.inc +++ b/include/class_ldap.inc @@ -28,9 +28,7 @@ define("NO_FILE_UPLOADED",10003); define("INSERT_OK",10000); define("SPECIALS_OVERRIDE", TRUE); -/*! \brief This is the ldap class - * - * This class contains all ldap function needed to make +/*! \brief This class contains all ldap function needed to make * ldap operations easy */ diff --git a/include/class_listing.inc b/include/class_listing.inc index c096d782b8dbdde02fcb14902d71e5ecc912082e..ff7f90ed3496bb65a3558a1925073f125cbce388 100644 --- a/include/class_listing.inc +++ b/include/class_listing.inc @@ -20,9 +20,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is the list class - * - * This class contains all the function needed to make the list +/*! \brief This class contains all the function needed to make the list * that show the objects inside FusionDirectory */ class listing { diff --git a/include/class_listingSortIterator.inc b/include/class_listingSortIterator.inc index 5c9f040cfe96aecb670f65f239d8ac2e44a17ef9..587b10c3ab6a08b123a27e5617aab7c00f234de5 100644 --- a/include/class_listingSortIterator.inc +++ b/include/class_listingSortIterator.inc @@ -20,10 +20,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is the iterator of the listing class - * - * This class contains all the function needed to make list - * go up, go donw , back , next. etc... +/*! \brief This class contains all the function needed to sort list + * go up, go down , back , next. etc... */ class listingSortIterator implements Iterator { private $data; diff --git a/include/class_log.inc b/include/class_log.inc index 2b30a2605b74c385c00158478c96a30fb93965be..e05b3f7d6962be5b4d5c2576fa897652f3e5f6a4 100644 --- a/include/class_log.inc +++ b/include/class_log.inc @@ -20,13 +20,12 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief The logging base class - \author Fabian Hickert <hickert@gonicus.de> - \version 2.6 - \date 11.04.2007 - - This is the base class for the FusionDirectory logging functionality. - All logging should lead to this class. +/*! \brief This is the base class for the FusionDirectory logging functionality. + * All logging should lead to this class. + * + * \author Fabian Hickert <hickert@gonicus.de> + * \version 2.6 + * \date 11.04.2007 */ class log { diff --git a/include/class_management.inc b/include/class_management.inc index d7dbddc2d6319b161e8250ced78b5ae143edd16d..5609c2d31c3e6fbe9b514988c65066d1169f7559 100644 --- a/include/class_management.inc +++ b/include/class_management.inc @@ -20,10 +20,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is plugin management class - * - * This class contains all the function needed to manage various function - * like new,save, edit, apply, cut/copy/paste , snapshot etc... +/*! \brief This class contains all the function needed to manage various + * functions like new,save, edit, apply, cut/copy/paste , snapshot etc... * */ class management diff --git a/include/class_msg_dialog.inc b/include/class_msg_dialog.inc index 9e347a28895546b9bf45fc4ffcd0beae43def428..643915b1d12af6b0d250d8842f22d9cc46e5d242 100644 --- a/include/class_msg_dialog.inc +++ b/include/class_msg_dialog.inc @@ -27,10 +27,8 @@ define("CONFIRM_DIALOG" , 10004); define("OK_CANCEL_DIALOG" , 10005); define("FATAL_ERROR_DIALOG" , 10006); -/*! \brief This is the message dialog class - * - * This class contains all the function needed to make - * messages dialogs +/*! \brief This class contains all the function needed to make messages + * dialogs */ class msg_dialog diff --git a/include/class_multi_plug.inc b/include/class_multi_plug.inc index 8798cf82911519daff9c3188b1ea3c29c2efa9f6..f2a34a9cdc3f7c455d65d8dea764c46bfb45b0f9 100644 --- a/include/class_multi_plug.inc +++ b/include/class_multi_plug.inc @@ -109,16 +109,16 @@ Using this class: */ - -/*! \brief Handles multiple edits for a given set of dns. - \author Fabian Hickert - \version 1.01 - \date 2007/12/07 - - This class edits multiple tab objects at once. - 1. There is a dummy tab object initialized that collects the user input. - 2. All given objects specified by '$dn' will be initialized and the collected - data from the dummy object will be populated to them. +/*! \brief This class edits multiple tab objects at once + * + * \author Fabian Hickert + * \version 1.01 + * \date 2007/12/07 + * + * This class edits multiple tab objects at once. + * 1. There is a dummy tab object initialized that collects the user input. + * 2. All given objects specified by '$dn' will be initialized and the collected + * data from the dummy object will be populated to them. */ class multi_plug { diff --git a/include/class_plugin.inc b/include/class_plugin.inc index 0a109a31a0e5d3bc1c497660a6c82f98a71707fb..5a6e223d422ac1afc55ef89d0c1b8b85cba3bde7 100644 --- a/include/class_plugin.inc +++ b/include/class_plugin.inc @@ -20,17 +20,16 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ - -/*! \brief The plugin base class - \author Cajus Pollmeier <pollmeier@gonicus.de> - \version 2.00 - \date 24.07.2003 - - This is the base class for all plugins. It can be used standalone or - can be included by the tabs class. All management should be done - within this class. Extend your plugins from this class. +/*! \brief This is the base class for all plugins. + * + * \author Cajus Pollmeier <pollmeier@gonicus.de> + * \version 2.00 + * \date 24.07.2003 + * + * This is the base class for all plugins. It can be used standalone or + * can be included by the tabs class. All management should be done + * within this class. Extend your plugins from this class. */ - class plugin { /*! diff --git a/include/class_pluglist.inc b/include/class_pluglist.inc index 04c225a2d6177a5ff89ec87beaad0cb7f39e0deb..b7f0a0d9dc8f5707c7ac93f45591f04cd3e0f4e7 100644 --- a/include/class_pluglist.inc +++ b/include/class_pluglist.inc @@ -20,9 +20,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is the plugin list class - * - * This class contains all the function needed to make list +/*! \brief This class contains all the function needed to make list * of plugin and manage them */ class pluglist { diff --git a/include/class_session.inc b/include/class_session.inc index 3bce2e01ec78e6bf4152a2bcbc8cd7a1cc473e6d..fd239e17c2f2ad6853d1a14587fa97dbc259eb40 100644 --- a/include/class_session.inc +++ b/include/class_session.inc @@ -20,9 +20,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief This is the session class - * - * This class contains all the function needed to manage sessions +/*! \brief This class contains all the function needed to manage sessions + * */ class session { diff --git a/include/class_sortableListing.inc b/include/class_sortableListing.inc index a4cd3ee266a27fc3f214157c26f576fa665e61e6..e9442a494dfcae7785dbad915effc6aab3deeb12 100644 --- a/include/class_sortableListing.inc +++ b/include/class_sortableListing.inc @@ -24,9 +24,7 @@ define ('LIST_NORMAL', 0); define ('LIST_MARKED', 1); define ('LIST_DISABLED', 2); -/*! \brief This is the Listing class - * - * This class contains all the function needed to make list +/*! \brief This class contains all the function needed to make list * and management them */ class sortableListing { diff --git a/include/class_supportDaemon.inc b/include/class_supportDaemon.inc index 8e49bb69a35374fdebd4939e8cbe47ca7a695e17..7ddc713463dcda8fc098ead90876c7fea3a13e76 100644 --- a/include/class_supportDaemon.inc +++ b/include/class_supportDaemon.inc @@ -22,10 +22,8 @@ require_once('jsonRPCClient.php'); -/*! \brief This is the argonaut support class - * - * This class contains all the function needed by the argonaut deplyoment system - * Inside FusionDirectory +/*! \brief This class contains all the function needed by the argonaut + * deployment system */ class supportDaemon { diff --git a/include/jsonRPCClient.php b/include/jsonRPCClient.php index e5c3cd97c24d51dd04d597e185b4bedc8fbcc621..a148ea1f4a6d6d689968d88bd8ae9be6d65bbeaa 100644 --- a/include/jsonRPCClient.php +++ b/include/jsonRPCClient.php @@ -21,8 +21,7 @@ along with JSON-RPC PHP; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -/** - * The object of this class are generic jsonRPC 1.0 clients +/*! \brief The object of this class are generic jsonRPC 1.0 clients * http://json-rpc.org/wiki/specification * * @author sergio <jsonrpcphp@inservibile.org> diff --git a/include/utils/class_msgPool.inc b/include/utils/class_msgPool.inc index 2cb1f1921ae01e302ab52f657ac04f896e0ed484..a637fb6108aadbf19c032c965053ad155b03561c 100644 --- a/include/utils/class_msgPool.inc +++ b/include/utils/class_msgPool.inc @@ -28,7 +28,9 @@ define ("LDAP_DEL", 4); define ("LDAP_SEARCH", 5); define ("LDAP_AUTH", 6); -/*! \brief Some common needed messages */ +/*! \brief This class contains all the messages for the various actions + * + */ class msgPool { diff --git a/include/utils/class_tests.inc b/include/utils/class_tests.inc index 4bcb77a83eabcf1c22a6b9366d0cc7dbfd706620..d944e11029765a9fe3206fef08be3406ecace32a 100644 --- a/include/utils/class_tests.inc +++ b/include/utils/class_tests.inc @@ -20,7 +20,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ -/*! \brief Test functions +/*! \brief This class provides various test functions * * This class provides various test functions. It enables to check * if a given value is: diff --git a/include/utils/class_timezone.inc b/include/utils/class_timezone.inc index 2ba9d1a7be3563c4cc8f27c7773d3ad3800ccb0d..c41ad40719af8f7830ffbb519dbcc24d2e32a7ce 100644 --- a/include/utils/class_timezone.inc +++ b/include/utils/class_timezone.inc @@ -20,6 +20,10 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ +/*! \brief This class contains all the function needed to manage the + * timezones + * + */ class timezone { /* This function returns the offset for the default timezone. diff --git a/include/utils/class_xml.inc b/include/utils/class_xml.inc index 8e05070868ebd93e6a27da3bfa45d7621816c9b3..b59f7babf1cdff19e04479bab23114b5d8a49860 100644 --- a/include/utils/class_xml.inc +++ b/include/utils/class_xml.inc @@ -20,6 +20,9 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ +/*! \brief This class contains all the function needed to manage xml + * files + */ class xml { static function validate($file, $schema) {