Skip to content

Instantly share code, notes, and snippets.

@komapa
Created May 30, 2011 13:36
Show Gist options
  • Save komapa/998904 to your computer and use it in GitHub Desktop.
Save komapa/998904 to your computer and use it in GitHub Desktop.
phpDoc fixes in the logger/ folder
Index: logger/BasicLogger.php
===================================================================
--- logger/BasicLogger.php (revision 2294)
+++ logger/BasicLogger.php (working copy)
@@ -27,65 +27,56 @@
/**
* A convenience function for logging an alert event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function alert($message);
/**
* A convenience function for logging a critical event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function crit($message);
/**
* A convenience function for logging an error event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function err($message);
/**
* A convenience function for logging a warning event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function warning($message);
/**
* A convenience function for logging an critical event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function notice($message);
/**
* A convenience function for logging an critical event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function info($message);
/**
* A convenience function for logging a debug event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function debug($message);
/**
* Primary method to handle logging.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
- * @param int $severity The numeric severity. Defaults to null so that no
+ * @param mixed $message String or Exception object containing the message to log.
+ * @param int $severity The numeric severity. Defaults to null so that no
* assumptions are made about the logging backend.
*/
public function log($message, $severity = null);
-
}
Index: logger/MojaviLogAdapter.php
===================================================================
--- logger/MojaviLogAdapter.php (revision 2294)
+++ logger/MojaviLogAdapter.php (working copy)
@@ -17,7 +17,6 @@
*/
class MojaviLogAdapter implements BasicLogger
{
-
/**
* Instance of mojavi logger
*/
@@ -26,7 +25,7 @@
/**
* constructor for setting up Mojavi log adapter
*
- * @param ErrorLog $logger instance of Mojavi error log obtained by
+ * @param ErrorLog $logger Instance of Mojavi error log obtained by
* calling LogManager::getLogger();
*/
public function __construct($logger = null)
@@ -37,8 +36,7 @@
/**
* A convenience function for logging an alert event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function alert($message)
{
@@ -48,8 +46,7 @@
/**
* A convenience function for logging a critical event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function crit($message)
{
@@ -59,8 +56,7 @@
/**
* A convenience function for logging an error event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function err($message)
{
@@ -70,8 +66,7 @@
/**
* A convenience function for logging a warning event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function warning($message)
{
@@ -82,8 +77,7 @@
/**
* A convenience function for logging an critical event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function notice($message)
{
@@ -92,8 +86,7 @@
/**
* A convenience function for logging an critical event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function info($message)
{
@@ -103,8 +96,7 @@
/**
* A convenience function for logging a debug event.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
+ * @param mixed $message String or Exception object containing the message to log.
*/
public function debug($message)
{
@@ -114,10 +106,9 @@
/**
* Primary method to handle logging.
*
- * @param mixed $message String or Exception object containing the message
- * to log.
- * @param int $severity The numeric severity. Defaults to null so that no
- * assumptions are made about the logging backend.
+ * @param mixed $message String or Exception object containing the message to log.
+ * @param integer $severity The numeric severity. Defaults to null so that no
+ * assumptions are made about the logging backend.
*/
public function log($message, $severity = null)
{
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment