From 8d2ea0d0e01c043efccf8278ed5d8a74a3cf95ba Mon Sep 17 00:00:00 2001
From: Benoit Mortier <benoit.mortier@opensides.be>
Date: Fri, 24 Feb 2012 11:18:21 +0100
Subject: [PATCH] Doxygen doc fixes
---
include/class_SnapShotDialog.inc | 4 +---
include/class_SnapshotHandler.inc | 4 +---
include/class_acl.inc | 4 +++-
include/class_ldap.inc | 4 +---
include/class_listing.inc | 4 +---
include/class_listingSortIterator.inc | 6 ++----
include/class_log.inc | 13 ++++++-------
include/class_management.inc | 6 ++----
include/class_msg_dialog.inc | 6 ++----
include/class_multi_plug.inc | 20 ++++++++++----------
include/class_plugin.inc | 19 +++++++++----------
include/class_pluglist.inc | 4 +---
include/class_session.inc | 5 ++---
include/class_sortableListing.inc | 4 +---
include/class_supportDaemon.inc | 6 ++----
include/jsonRPCClient.php | 3 +--
include/utils/class_msgPool.inc | 4 +++-
include/utils/class_tests.inc | 2 +-
include/utils/class_timezone.inc | 4 ++++
include/utils/class_xml.inc | 3 +++
20 files changed, 56 insertions(+), 69 deletions(-)
diff --git a/include/class_SnapShotDialog.inc b/include/class_SnapShotDialog.inc
index 50797f807..9020bff51 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 493b61287..e09b9accd 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 e67ad5612..be8e02364 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 0478a4615..a0ca0159a 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 c096d782b..ff7f90ed3 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 5c9f040cf..587b10c3a 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 2b30a2605..e05b3f7d6 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 d7dbddc2d..5609c2d31 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 9e347a288..643915b1d 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 8798cf829..f2a34a9cd 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 0a109a31a..5a6e223d4 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 04c225a2d..b7f0a0d9d 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 3bce2e01e..fd239e17c 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 a4cd3ee26..e9442a494 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 8e49bb69a..7ddc71346 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 e5c3cd97c..a148ea1f4 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 2cb1f1921..a637fb610 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 4bcb77a83..d944e1102 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 2ba9d1a7b..c41ad4071 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 8e0507086..b59f7babf 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) {
--
GitLab