Author: dr
Date: Mon Feb 4 09:43:55 2008
New Revision: 7277
Log:
- Fixed documentation.
Modified:
trunk/EventLog/src/exceptions/writer_exception.php
trunk/EventLog/src/interfaces/writer.php
trunk/EventLog/src/log.php
trunk/EventLog/src/mapper/filter_rule.php
trunk/EventLog/src/structs/log_filter.php
trunk/EventLog/src/writers/writer_file.php
trunk/EventLog/src/writers/writer_syslog.php
trunk/EventLog/src/writers/writer_unix_file.php
Modified: trunk/EventLog/src/exceptions/writer_exception.php
==============================================================================
--- trunk/EventLog/src/exceptions/writer_exception.php [iso-8859-1] (original)
+++ trunk/EventLog/src/exceptions/writer_exception.php [iso-8859-1] Mon Feb 4
09:43:55 2008
@@ -30,7 +30,7 @@
/**
* Constructs a new ezcLogWriterException with the original exception $e.
*
- * @param Exception $e;
+ * @param Exception $e
*/
public function __construct( Exception $e )
{
Modified: trunk/EventLog/src/interfaces/writer.php
==============================================================================
--- trunk/EventLog/src/interfaces/writer.php [iso-8859-1] (original)
+++ trunk/EventLog/src/interfaces/writer.php [iso-8859-1] Mon Feb 4 09:43:55
2008
@@ -36,7 +36,7 @@
* @param int $severity
* ezcLog::DEBUG, ezcLog::SUCCESS_AUDIT, ezcLog::FAILED_AUDIT,
ezcLog::INFO, ezcLog::NOTICE,
* ezcLog::WARNING, ezcLog::ERROR or ezcLog::FATAL.
- * $param string $source
+ * @param string $source
* @param string $category
* @param array(string=>string) $optional
*/
Modified: trunk/EventLog/src/log.php
==============================================================================
--- trunk/EventLog/src/log.php [iso-8859-1] (original)
+++ trunk/EventLog/src/log.php [iso-8859-1] Mon Feb 4 09:43:55 2008
@@ -338,7 +338,7 @@
/**
* Returns an instance of the current ezcLogMapper.
*
- * return ezcLogMapper
+ * @return ezcLogMapper
*/
public function getMapper()
{
@@ -500,7 +500,7 @@
* includes the Merchant ID.
*
* @param array(string) $sources
- * @param array(string => string) $attributes
+ * @param array(string=>string) $attributes
*/
public function setSourceAttributes ( $sources, $attributes )
{
Modified: trunk/EventLog/src/mapper/filter_rule.php
==============================================================================
--- trunk/EventLog/src/mapper/filter_rule.php [iso-8859-1] (original)
+++ trunk/EventLog/src/mapper/filter_rule.php [iso-8859-1] Mon Feb 4 09:43:55
2008
@@ -188,6 +188,7 @@
/**
* Returns the bits set in $mask as separate values in an array.
*
+ * @param int $mask
* @return array(int)
*/
protected function getMaskArray( $mask )
Modified: trunk/EventLog/src/structs/log_filter.php
==============================================================================
--- trunk/EventLog/src/structs/log_filter.php [iso-8859-1] (original)
+++ trunk/EventLog/src/structs/log_filter.php [iso-8859-1] Mon Feb 4 09:43:55
2008
@@ -61,6 +61,10 @@
/**
* Empty constructor
+ *
+ * @param int $severity
+ * @param array(string) $source
+ * @param array(string) $category
*/
public function __construct( $severity = 0, array $source = array(), array
$category = array() )
{
Modified: trunk/EventLog/src/writers/writer_file.php
==============================================================================
--- trunk/EventLog/src/writers/writer_file.php [iso-8859-1] (original)
+++ trunk/EventLog/src/writers/writer_file.php [iso-8859-1] Mon Feb 4 09:43:55
2008
@@ -100,8 +100,8 @@
*
* @param string $logDirectory
* @param string $defaultFile
- * @param string $maxLogRotationSize
- * @param string $maxLogFiles
+ * @param int $maxLogRotationSize
+ * @param int $maxLogFiles
*/
public function __construct( $logDirectory, $defaultFile = null,
$maxLogRotationSize = 204800, $maxLogFiles = 3 )
{
@@ -179,6 +179,7 @@
*
* If the maximum file size is exceeded, the file will be rotated before
opening.
*
+ * @param string $fileName
* @return resource
*/
protected function openFile( $fileName )
@@ -216,6 +217,7 @@
/**
* Rotates a log and returns true upon success.
*
+ * @param string $fileName
* @return bool
*/
protected function rotateLog( $fileName )
Modified: trunk/EventLog/src/writers/writer_syslog.php
==============================================================================
--- trunk/EventLog/src/writers/writer_syslog.php [iso-8859-1] (original)
+++ trunk/EventLog/src/writers/writer_syslog.php [iso-8859-1] Mon Feb 4
09:43:55 2008
@@ -79,9 +79,9 @@
* @param int $severity
* ezcLog::DEBUG, ezcLog::SUCCESS_AUDIT, ezcLog::FAILED_AUDIT,
ezcLog::INFO, ezcLog::NOTICE,
* ezcLog::WARNING, ezcLog::ERROR or ezcLog::FATAL.
- * $param string $source
+ * @param string $source
* @param string $category
- * @param array(string=>string) $optional
+ * @param array(string=>string) $extraInfo
*/
public function writeLogMessage( $message, $severity, $source, $category,
$extraInfo = array() )
{
Modified: trunk/EventLog/src/writers/writer_unix_file.php
==============================================================================
--- trunk/EventLog/src/writers/writer_unix_file.php [iso-8859-1] (original)
+++ trunk/EventLog/src/writers/writer_unix_file.php [iso-8859-1] Mon Feb 4
09:43:55 2008
@@ -44,7 +44,7 @@
*
* @param string $message
* @param int $eventType
- * @param string $eventType
+ * @param string $eventSource
* @param string $eventCategory
* @param array(string=>string) $extraInfo
*/
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
