logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ihabu...@apache.org
Subject svn commit: r1166187 - in /logging/log4php/trunk/src/main/php: ./ configurators/ helpers/ layouts/ renderers/
Date Wed, 07 Sep 2011 13:59:05 GMT
Author: ihabunek
Date: Wed Sep  7 13:59:04 2011
New Revision: 1166187

URL: http://svn.apache.org/viewvc?rev=1166187&view=rev
Log:
Removed unneccessary annotations (those which can be determined from class/method/param signature):
@private, @public, @static, @abstract, @final. A lot of these were wrong, anyway.

Modified:
    logging/log4php/trunk/src/main/php/Logger.php
    logging/log4php/trunk/src/main/php/LoggerLayout.php
    logging/log4php/trunk/src/main/php/LoggerLevel.php
    logging/log4php/trunk/src/main/php/LoggerLoggingEvent.php
    logging/log4php/trunk/src/main/php/LoggerMDC.php
    logging/log4php/trunk/src/main/php/LoggerNDC.php
    logging/log4php/trunk/src/main/php/LoggerReflectionUtils.php
    logging/log4php/trunk/src/main/php/configurators/LoggerConfiguratorXml.php
    logging/log4php/trunk/src/main/php/helpers/LoggerNamedPatternConverter.php
    logging/log4php/trunk/src/main/php/helpers/LoggerOptionConverter.php
    logging/log4php/trunk/src/main/php/helpers/LoggerPatternConverter.php
    logging/log4php/trunk/src/main/php/layouts/LoggerLayoutXml.php
    logging/log4php/trunk/src/main/php/renderers/LoggerRendererMap.php

Modified: logging/log4php/trunk/src/main/php/Logger.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/Logger.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/Logger.php (original)
+++ logging/log4php/trunk/src/main/php/Logger.php Wed Sep  7 13:59:04 2011
@@ -349,7 +349,6 @@ class Logger {
 	 * @param string $name logger name
 	 * @param LoggerFactory $factory a {@link LoggerFactory} instance or null
 	 * @return Logger
-	 * @static 
 	 */
 	public static function getLogger($name) {
 		if(!self::isInitialized()) {
@@ -361,7 +360,6 @@ class Logger {
 	/**
 	 * Get the Root Logger (Delegate to {@link Logger})
 	 * @return LoggerRoot
-	 * @static 
 	 */	   
 	public static function getRootLogger() {
 		if(!self::isInitialized()) {
@@ -479,8 +477,6 @@ class Logger {
 	
 	/**
 	 * Clears all Logger definitions from the logger hierarchy.
-	 * 
-	 * @static
 	 * @return boolean 
 	 */
 	public static function clear() {
@@ -489,8 +485,6 @@ class Logger {
 	
 	/**
 	 * Destroy configurations for logger definitions
-	 * 
-	 * @static
 	 * @return boolean 
 	 */
 	public static function resetConfiguration() {
@@ -503,10 +497,8 @@ class Logger {
 
 	/**
 	 * Safely close all appenders.
-	 * 
 	 * @deprecated This is no longer necessary due the appenders shutdown via
 	 * destructors.
-	 * @static
 	 */
 	public static function shutdown() {
 		return self::getHierarchy()->shutdown();	   
@@ -516,7 +508,6 @@ class Logger {
 	 * check if a given logger exists.
 	 * 
 	 * @param string $name logger name 
-	 * @static
 	 * @return boolean
 	 */
 	public static function exists($name) {
@@ -525,8 +516,6 @@ class Logger {
 	
 	/**
 	 * Returns an array this whole Logger instances.
-	 * 
-	 * @static
 	 * @see Logger
 	 * @return array
 	 */

Modified: logging/log4php/trunk/src/main/php/LoggerLayout.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/LoggerLayout.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/LoggerLayout.php (original)
+++ logging/log4php/trunk/src/main/php/LoggerLayout.php Wed Sep  7 13:59:04 2011
@@ -23,7 +23,6 @@
  *	
  * @version $Revision$
  * @package log4php
- * @abstract
  */
 abstract class LoggerLayout {
 	/**

Modified: logging/log4php/trunk/src/main/php/LoggerLevel.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/LoggerLevel.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/LoggerLevel.php (original)
+++ logging/log4php/trunk/src/main/php/LoggerLevel.php Wed Sep  7 13:59:04 2011
@@ -94,7 +94,6 @@ class LoggerLevel {
 	
 	/**
 	 * Returns an Off Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelOff() {
@@ -106,7 +105,6 @@ class LoggerLevel {
 
 	/**
 	 * Returns a Fatal Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelFatal() {
@@ -118,7 +116,6 @@ class LoggerLevel {
 	
 	/**
 	 * Returns an Error Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelError() {
@@ -130,7 +127,6 @@ class LoggerLevel {
 	
 	/**
 	 * Returns a Warn Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelWarn() {
@@ -142,7 +138,6 @@ class LoggerLevel {
 
 	/**
 	 * Returns an Info Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelInfo() {
@@ -154,7 +149,6 @@ class LoggerLevel {
 
 	/**
 	 * Returns a Debug Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelDebug() {
@@ -166,7 +160,6 @@ class LoggerLevel {
 	
 	/**
 	 * Returns a Trace Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelTrace() {
@@ -178,7 +171,6 @@ class LoggerLevel {
 
 	/**
 	 * Returns an All Level
-	 * @static
 	 * @return LoggerLevel
 	 */
 	public static function getLevelAll() {
@@ -190,7 +182,6 @@ class LoggerLevel {
 	
 	/**
 	 * Return the syslog equivalent of this priority as an integer.
-	 * @final
 	 * @return integer
 	 */
 	public function getSyslogEquivalent() {
@@ -242,7 +233,6 @@ class LoggerLevel {
 	 *
 	 * @param mixed $arg
 	 * @param LoggerLevel $default
-	 * @static 
 	 */
 	public static function toLevel($arg, $defaultLevel = null) {
 		if($defaultLevel === null) {

Modified: logging/log4php/trunk/src/main/php/LoggerLoggingEvent.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/LoggerLoggingEvent.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/LoggerLoggingEvent.php (original)
+++ logging/log4php/trunk/src/main/php/LoggerLoggingEvent.php Wed Sep  7 13:59:04 2011
@@ -297,9 +297,7 @@ class LoggerLoggingEvent {
 	/**
 	 * Returns the time when the application started, in seconds
 	 * elapsed since 01.01.1970 plus microseconds if available.
-	 *
 	 * @return float
-	 * @static
 	 */
 	public static function getStartTime() {
 		if(!isset(self::$startTime)) {

Modified: logging/log4php/trunk/src/main/php/LoggerMDC.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/LoggerMDC.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/LoggerMDC.php (original)
+++ logging/log4php/trunk/src/main/php/LoggerMDC.php Wed Sep  7 13:59:04 2011
@@ -67,7 +67,6 @@ class LoggerMDC {
 	 *
 	 * @param string $key the key
 	 * @param string $value the value
-	 * @static
 	 */
 	public static function put($key, $value) {
 		self::$map[$key] = $value;
@@ -85,7 +84,6 @@ class LoggerMDC {
 	 * @param string $key the key
 	 * @return string the context or an empty string if no context found
 	 * 	for given key
-	 * @static
 	 */
 	public static function get($key) {
 		if(!empty($key)) {
@@ -109,7 +107,6 @@ class LoggerMDC {
 	 * It only affects user mappings, not $_ENV or $_SERVER.
 	 *
 	 * @param string $key the key to be removed
-	 * @static
 	 */
 	public static function remove($key) {
 		unset(self::$map[$key]);

Modified: logging/log4php/trunk/src/main/php/LoggerNDC.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/LoggerNDC.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/LoggerNDC.php (original)
+++ logging/log4php/trunk/src/main/php/LoggerNDC.php Wed Sep  7 13:59:04 2011
@@ -105,8 +105,6 @@ class LoggerNDC {
 	 *
 	 * <p>This method is equivalent to calling the {@link setMaxDepth()}
 	 * method with a zero <var>maxDepth</var> argument.
-	 *
-	 * @static
 	 */
 	public static function clear() {
 		self::$stack = array();
@@ -114,7 +112,6 @@ class LoggerNDC {
 
 	/**
 	 * Never use this method directly, use the {@link LoggerLoggingEvent::getNDC()} method instead.
-	 * @static
 	 * @return array
 	 */
 	public static function get() {
@@ -126,7 +123,6 @@ class LoggerNDC {
 	 *
 	 * @see setMaxDepth()
 	 * @return integer
-	 * @static
 	 */
 	public static function getDepth() {
 		return count(self::$stack);
@@ -140,7 +136,6 @@ class LoggerNDC {
 	 * context is available, then the empty string "" is returned.</p>
 	 *
 	 * @return string The innermost diagnostic context.
-	 * @static
 	 */
 	public static function pop() {
 		if(count(self::$stack) > 0) {
@@ -157,7 +152,6 @@ class LoggerNDC {
 	 * <p>The returned value is the value that was pushed last. If no
 	 * context is available, then the empty string "" is returned.</p>
 	 * @return string The innermost diagnostic context.
-	 * @static
 	 */
 	public static function peek(){
 		if(count(self::$stack) > 0) {
@@ -174,7 +168,6 @@ class LoggerNDC {
 	 * determined solely by the client.
 	 *	
 	 * @param string $message The new diagnostic context information.
-	 * @static	
 	 */
 	public static function push($message) {
 		array_push(self::$stack, (string)$message);
@@ -182,7 +175,6 @@ class LoggerNDC {
 
 	/**
 	 * Remove the diagnostic context for this thread.
-	 * @static
 	 */
 	public static function remove() {
 		LoggerNDC::clear();
@@ -201,7 +193,6 @@ class LoggerNDC {
 	 *
 	 * @param integer $maxDepth
 	 * @see getDepth()
-	 * @static
 	 */
 	public static function setMaxDepth($maxDepth) {
 		$maxDepth = (int)$maxDepth;

Modified: logging/log4php/trunk/src/main/php/LoggerReflectionUtils.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/LoggerReflectionUtils.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/LoggerReflectionUtils.php (original)
+++ logging/log4php/trunk/src/main/php/LoggerReflectionUtils.php Wed Sep  7 13:59:04 2011
@@ -44,7 +44,6 @@ class LoggerReflectionUtils {
 	 * @param object $obj The object to configure.
 	 * @param array $properties An array containing keys and values.
 	 * @param string $prefix Only keys having the specified prefix will be set.
-	 * @static
 	 */
 	 // TODO: check, if this is really useful
 	public static function setPropertiesByObject($obj, $properties, $prefix) {

Modified: logging/log4php/trunk/src/main/php/configurators/LoggerConfiguratorXml.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/configurators/LoggerConfiguratorXml.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/configurators/LoggerConfiguratorXml.php (original)
+++ logging/log4php/trunk/src/main/php/configurators/LoggerConfiguratorXml.php Wed Sep  7
13:59:04 2011
@@ -120,7 +120,6 @@ class LoggerConfiguratorXml implements L
 	 * set to "1".
 	 *
 	 * @param string $url
-	 * @static
 	 */
 	public function configure(LoggerHierarchy $hierarchy, $url = '') {
 		return $this->doConfigure($url, $hierarchy);

Modified: logging/log4php/trunk/src/main/php/helpers/LoggerNamedPatternConverter.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/helpers/LoggerNamedPatternConverter.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/helpers/LoggerNamedPatternConverter.php (original)
+++ logging/log4php/trunk/src/main/php/helpers/LoggerNamedPatternConverter.php Wed Sep  7
13:59:04 2011
@@ -21,7 +21,6 @@
 /**
  * @package log4php
  * @subpackage helpers
- * @abstract
  */
 class LoggerNamedPatternConverter extends LoggerPatternConverter {
 
@@ -44,10 +43,8 @@ class LoggerNamedPatternConverter extend
 	/**
 	 * @param LoggerLoggingEvent $event
 	 * @return string
-	 * @abstract
 	 */
 	public function getFullyQualifiedName($event) {
-		// abstract
 		return;
 	}
 

Modified: logging/log4php/trunk/src/main/php/helpers/LoggerOptionConverter.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/helpers/LoggerOptionConverter.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/helpers/LoggerOptionConverter.php (original)
+++ logging/log4php/trunk/src/main/php/helpers/LoggerOptionConverter.php Wed Sep  7 13:59:04
2011
@@ -24,7 +24,6 @@
  * @version $Revision$ 
  * @package log4php
  * @subpackage helpers
- * @static
  * @since 0.5
  */
 class LoggerOptionConverter {
@@ -46,8 +45,6 @@ class LoggerOptionConverter {
 	 * @param string $def The default value to return.
 	 * @return string	the string value of the system property, or the default
 	 *					value if there is no property with that key.
-	 *
-	 * @static
 	 */
 	public static function getSystemProperty($key, $def) {
 		if(defined($key)) {
@@ -72,8 +69,6 @@ class LoggerOptionConverter {
 	 * @param string $value
 	 * @param boolean $default
 	 * @return boolean
-	 *
-	 * @static
 	 */
 	public static function toBoolean($value, $default=true) {
 		if (is_null($value)) {
@@ -99,7 +94,6 @@ class LoggerOptionConverter {
 	 * @param string $value
 	 * @param integer $default
 	 * @return integer
-	 * @static
 	 */
 	public static function toInt($value, $default) {
 		$value = trim($value);
@@ -135,7 +129,6 @@ class LoggerOptionConverter {
 	 * @param string $value
 	 * @param LoggerLevel $defaultValue
 	 * @return LoggerLevel a {@link LoggerLevel} or null
-	 * @static
 	 */
 	public static function toLevel($value, $defaultValue) {
 		if($value === null) {
@@ -176,8 +169,6 @@ class LoggerOptionConverter {
 	 * @param string $value
 	 * @param float $default
 	 * @return float
-	 *
-	 * @static
 	 */
 	public static function toFileSize($value, $default) {
 		if($value === null) {
@@ -210,8 +201,6 @@ class LoggerOptionConverter {
 	 * @param string $key
 	 * @param array $props
 	 * @return string
-	 *
-	 * @static
 	 */
 	public static function findAndSubst($key, $props) {
 		$value = @$props[$key];
@@ -267,8 +256,6 @@ class LoggerOptionConverter {
 	 * @param string $val The string on which variable substitution is performed.
 	 * @param array $props
 	 * @return string
-	 *
-	 * @static
 	 */
 	 // TODO: this method doesn't work correctly with key = true, it needs key = "true" which
is odd
 	public static function substVars($val, $props = null) {

Modified: logging/log4php/trunk/src/main/php/helpers/LoggerPatternConverter.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/helpers/LoggerPatternConverter.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/helpers/LoggerPatternConverter.php (original)
+++ logging/log4php/trunk/src/main/php/helpers/LoggerPatternConverter.php Wed Sep  7 13:59:04
2011
@@ -30,7 +30,6 @@
  * @version $Revision$
  * @package log4php
  * @subpackage helpers
- * @abstract
  * @since 0.3
  */
 class LoggerPatternConverter {

Modified: logging/log4php/trunk/src/main/php/layouts/LoggerLayoutXml.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/layouts/LoggerLayoutXml.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/layouts/LoggerLayoutXml.php (original)
+++ logging/log4php/trunk/src/main/php/layouts/LoggerLayoutXml.php Wed Sep  7 13:59:04 2011
@@ -82,13 +82,11 @@ class LoggerLayoutXml extends LoggerLayo
 	
 	/**
 	 * @var string namespace
-	 * @private
 	 */
 	private $_namespace = self::LOG4PHP_NS;
 	
 	/**
 	 * @var string namespace prefix
-	 * @private
 	 */
 	private $_namespacePrefix = self::LOG4PHP_NS_PREFIX;
 	 
@@ -209,7 +207,6 @@ class LoggerLayoutXml extends LoggerLayo
 	 *						the calling method.
 	 * @param string str	The String that is inserted into an existing 
 	 *						CDATA Section within buf.
-	 * @static  
 	 */
 	private function appendEscapingCDATA(&$buf, $str) {
 		if(empty($str)) {

Modified: logging/log4php/trunk/src/main/php/renderers/LoggerRendererMap.php
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/main/php/renderers/LoggerRendererMap.php?rev=1166187&r1=1166186&r2=1166187&view=diff
==============================================================================
--- logging/log4php/trunk/src/main/php/renderers/LoggerRendererMap.php (original)
+++ logging/log4php/trunk/src/main/php/renderers/LoggerRendererMap.php Wed Sep  7 13:59:04
2011
@@ -61,7 +61,6 @@ class LoggerRendererMap {
 	 * @param LoggerHierarchy $repository a logger repository.
 	 * @param string $renderedClassName
 	 * @param string $renderingClassName
-	 * @static
 	 */
 	public function addRenderer($renderedClassName, $renderingClassName) {
 		$renderer = LoggerReflectionUtils::createObject($renderingClassName);



Mime
View raw message