From 842982f134f8aa5763d36abfdf4a068b16355ea2 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@destailleur.fr>
Date: Sun, 11 Nov 2012 17:50:24 +0100
Subject: [PATCH] Doxygen

---
 htdocs/core/modules/syslog/logHandler.php     |  2 +-
 .../modules/syslog/logHandlerInterface.php    | 46 +++++++++++++++++++
 .../modules/syslog/mod_syslog_chromephp.php   | 32 ++++++++++---
 .../core/modules/syslog/mod_syslog_file.php   | 32 ++++++++++---
 .../modules/syslog/mod_syslog_firephp.php     | 36 +++++++++++----
 .../core/modules/syslog/mod_syslog_syslog.php | 31 ++++++++++---
 6 files changed, 148 insertions(+), 31 deletions(-)

diff --git a/htdocs/core/modules/syslog/logHandler.php b/htdocs/core/modules/syslog/logHandler.php
index dbca7b306ac..ff889934278 100644
--- a/htdocs/core/modules/syslog/logHandler.php
+++ b/htdocs/core/modules/syslog/logHandler.php
@@ -28,7 +28,7 @@ class LogHandler
 	}
 
 	/**
-	 * ¿Is the module active?
+	 * Is the module active ?
 	 *
 	 * @return boolean
 	 */
diff --git a/htdocs/core/modules/syslog/logHandlerInterface.php b/htdocs/core/modules/syslog/logHandlerInterface.php
index ba8f6febc27..7b5a4aa1bdd 100644
--- a/htdocs/core/modules/syslog/logHandlerInterface.php
+++ b/htdocs/core/modules/syslog/logHandlerInterface.php
@@ -1,12 +1,58 @@
 <?php
 
+/**
+ * LogHandlerInterface
+ */
 interface LogHandlerInterface
 {
+	/**
+	 * 	Return name of logger
+	 *
+	 * 	@return	string		Name of logger
+	 */
 	public function getName();
+
+
+	/**
+	 * 	Return version of logger
+	 *
+	 * 	@return	string		Version of logger
+	 */
 	public function getVersion();
+
+	/**
+	 * 	Return information on logger
+	 *
+	 * 	@return	string		Version of logger
+	 */
 	public function getInfo();
+
+	/**
+	 * 	Return array of configuration data
+	 *
+	 * 	@return	array		Return array of configuration data
+	 */
 	public function configure();
+
+	/**
+	 * 	Return if configuration is valid
+	 *
+	 * 	@return	boolean		True if configuration ok
+	 */
 	public function checkConfiguration();
+
+	/**
+	 * 	Return if logger active
+	 *
+	 * 	@return	boolen		True if active
+	 */
 	public function isActive();
+
+	/**
+	 * 	Output log content
+	 *
+	 *	@param	string	$content	Content to log
+	 * 	@return	void
+	 */
 	public function export($content);
 }
\ No newline at end of file
diff --git a/htdocs/core/modules/syslog/mod_syslog_chromephp.php b/htdocs/core/modules/syslog/mod_syslog_chromephp.php
index ffbdaba9e22..0d838959166 100644
--- a/htdocs/core/modules/syslog/mod_syslog_chromephp.php
+++ b/htdocs/core/modules/syslog/mod_syslog_chromephp.php
@@ -2,10 +2,15 @@
 
 require_once DOL_DOCUMENT_ROOT.'/core/modules/syslog/logHandler.php';
 
+/**
+ * Class to manage logging to ChromPHP
+ */
 class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 {
 	/**
-	 * {@inheritDoc}
+	 * 	Return name of logger
+	 *
+	 * 	@return	string		Name of logger
 	 */
 	public function getName()
 	{
@@ -13,7 +18,9 @@ class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
+	 *
+	 * @return string
 	 */
 	public function getVersion()
 	{
@@ -21,7 +28,9 @@ class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Content of the info tooltip.
+	 *
+	 * @return false|string
 	 */
 	public function getInfo()
 	{
@@ -31,7 +40,9 @@ class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Is the module active ?
+	 *
+	 * @return boolean
 	 */
 	public function isActive()
 	{
@@ -56,7 +67,9 @@ class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return array of configuration data
+	 *
+	 * 	@return	array		Return array of configuration data
 	 */
 	public function configure()
 	{
@@ -73,7 +86,9 @@ class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return if configuration is valid
+	 *
+	 * 	@return	boolean		True if configuration ok
 	 */
 	public function checkConfiguration()
 	{
@@ -95,7 +110,10 @@ class mod_syslog_chromephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Output log content
+	 *
+	 *	@param	string	$content	Content to log
+	 * 	@return	void
 	 */
 	public function export($content)
 	{
diff --git a/htdocs/core/modules/syslog/mod_syslog_file.php b/htdocs/core/modules/syslog/mod_syslog_file.php
index 6920d35bb48..2fce762a848 100644
--- a/htdocs/core/modules/syslog/mod_syslog_file.php
+++ b/htdocs/core/modules/syslog/mod_syslog_file.php
@@ -2,10 +2,15 @@
 
 require_once DOL_DOCUMENT_ROOT.'/core/modules/syslog/logHandler.php';
 
+/**
+ * Class to manage logging to a file
+ */
 class mod_syslog_file extends LogHandler implements LogHandlerInterface
 {
 	/**
-	 * {@inheritDoc}
+	 * 	Return name of logger
+	 *
+	 * 	@return	string		Name of logger
 	 */
 	public function getName()
 	{
@@ -15,7 +20,9 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
+	 *
+	 * @return string
 	 */
 	public function getVersion()
 	{
@@ -23,7 +30,9 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Content of the info tooltip.
+	 *
+	 * @return false|string
 	 */
 	public function getInfo()
 	{
@@ -33,7 +42,9 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Is the module active ?
+	 *
+	 * @return boolean
 	 */
 	public function isActive()
 	{
@@ -41,7 +52,9 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return array of configuration data
+	 *
+	 * 	@return	array		Return array of configuration data
 	 */
 	public function configure()
 	{
@@ -58,7 +71,9 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return if configuration is valid
+	 *
+	 * 	@return	boolean		True if configuration ok
 	 */
 	public function checkConfiguration()
 	{
@@ -79,6 +94,7 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 
 	/**
 	 * Return the parsed logfile path
+	 *
 	 * @return string
 	 */
 	private function getFilename()
@@ -88,7 +104,9 @@ class mod_syslog_file extends LogHandler implements LogHandlerInterface
 
 	/**
 	 * Export the message
-	 * @param  array $content Array containing the info about the message
+	 *
+	 * @param  	array 	$content 	Array containing the info about the message
+	 * @return	void
 	 */
 	public function export($content)
 	{
diff --git a/htdocs/core/modules/syslog/mod_syslog_firephp.php b/htdocs/core/modules/syslog/mod_syslog_firephp.php
index fc9ee6491d7..311c43ca207 100644
--- a/htdocs/core/modules/syslog/mod_syslog_firephp.php
+++ b/htdocs/core/modules/syslog/mod_syslog_firephp.php
@@ -2,10 +2,15 @@
 
 require_once DOL_DOCUMENT_ROOT.'/core/modules/syslog/logHandler.php';
 
+/**
+ * Class to manage logging to a FirePHP
+ */
 class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 {
 	/**
-	 * {@inheritDoc}
+	 * 	Return name of logger
+	 *
+	 * 	@return	string		Name of logger
 	 */
 	public function getName()
 	{
@@ -13,7 +18,9 @@ class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
+	 *
+	 * @return string
 	 */
 	public function getVersion()
 	{
@@ -21,7 +28,9 @@ class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Content of the info tooltip.
+	 *
+	 * @return false|string
 	 */
 	public function getInfo()
 	{
@@ -31,7 +40,9 @@ class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Is the module active ?
+	 *
+	 * @return boolean
 	 */
 	public function isActive()
 	{
@@ -53,9 +64,11 @@ class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 		return -1;
 	}
 
-	// /**
-	//  * {@inheritDoc}
-	//  */
+	///**
+	// * 	Return array of configuration data
+	// *
+	// * 	@return	array		Return array of configuration data
+	// */
 	// public function configure()
 	// {
 	// 	global $langs;
@@ -71,7 +84,9 @@ class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 	// }
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return if configuration is valid
+	 *
+	 * 	@return	boolean		True if configuration ok
 	 */
 	public function checkConfiguration()
 	{
@@ -93,7 +108,10 @@ class mod_syslog_firephp extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Output log content
+	 *
+	 *	@param	string	$content	Content to log
+	 * 	@return	void
 	 */
 	public function export($content)
 	{
diff --git a/htdocs/core/modules/syslog/mod_syslog_syslog.php b/htdocs/core/modules/syslog/mod_syslog_syslog.php
index b708d8ac877..09353dc5119 100644
--- a/htdocs/core/modules/syslog/mod_syslog_syslog.php
+++ b/htdocs/core/modules/syslog/mod_syslog_syslog.php
@@ -2,10 +2,15 @@
 
 require_once DOL_DOCUMENT_ROOT.'/core/modules/syslog/logHandler.php';
 
+/**
+ * Class to manage logging to syslog
+ */
 class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 {
 	/**
-	 * {@inheritDoc}
+	 * 	Return name of logger
+	 *
+	 * 	@return	string		Name of logger
 	 */
 	public function getName()
 	{
@@ -13,7 +18,9 @@ class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Version of the module ('x.y.z' or 'dolibarr' or 'experimental' or 'development')
+	 *
+	 * @return string
 	 */
 	public function getVersion()
 	{
@@ -21,7 +28,9 @@ class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Content of the info tooltip.
+	 *
+	 * @return false|string
 	 */
 	public function getInfo()
 	{
@@ -31,7 +40,9 @@ class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Is the module active ?
+	 *
+	 * @return boolean
 	 */
 	public function isActive()
 	{
@@ -45,7 +56,9 @@ class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return array of configuration data
+	 *
+	 * 	@return	array		Return array of configuration data
 	 */
 	public function configure()
 	{
@@ -61,7 +74,9 @@ class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * 	Return if configuration is valid
+	 *
+	 * 	@return	boolean		True if configuration ok
 	 */
 	public function checkConfiguration()
 	{
@@ -87,7 +102,9 @@ class mod_syslog_syslog extends LogHandler implements LogHandlerInterface
 
 	/**
 	 * Export the message
-	 * @param  array $content Array containing the info about the message
+	 *
+	 * @param  	array 	$content 	Array containing the info about the message
+	 * @return	void
 	 */
 	public function export($content)
 	{