Author: chammers
Date: Tue Oct 6 19:23:53 2009
New Revision: 822448
URL: http://svn.apache.org/viewvc?rev=822448&view=rev
Log:
Only phpdoc changes
Modified:
incubator/log4php/trunk/src/main/php/Logger.php
incubator/log4php/trunk/src/main/php/LoggerAppenderPool.php
incubator/log4php/trunk/src/main/php/LoggerConfigurator.php
incubator/log4php/trunk/src/main/php/LoggerException.php
incubator/log4php/trunk/src/main/php/LoggerFilter.php
incubator/log4php/trunk/src/main/php/LoggerHierarchy.php
incubator/log4php/trunk/src/main/php/LoggerLevel.php
incubator/log4php/trunk/src/main/php/LoggerLocationInfo.php
incubator/log4php/trunk/src/main/php/LoggerLoggingEvent.php
incubator/log4php/trunk/src/main/php/LoggerMDC.php
incubator/log4php/trunk/src/main/php/LoggerNDC.php
incubator/log4php/trunk/src/main/php/LoggerReflectionUtils.php
incubator/log4php/trunk/src/main/php/LoggerRoot.php
Modified: incubator/log4php/trunk/src/main/php/Logger.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/Logger.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/Logger.php (original)
+++ incubator/log4php/trunk/src/main/php/Logger.php Tue Oct 6 19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerAppenderPool.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerAppenderPool.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerAppenderPool.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerAppenderPool.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerConfigurator.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerConfigurator.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerConfigurator.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerConfigurator.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerException.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerException.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerException.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerException.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerFilter.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerFilter.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerFilter.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerFilter.php Tue Oct 6 19:23:53
2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerHierarchy.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerHierarchy.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerHierarchy.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerHierarchy.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerLevel.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerLevel.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerLevel.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerLevel.php Tue Oct 6 19:23:53
2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerLocationInfo.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerLocationInfo.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerLocationInfo.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerLocationInfo.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerLoggingEvent.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerLoggingEvent.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerLoggingEvent.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerLoggingEvent.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerMDC.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerMDC.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerMDC.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerMDC.php Tue Oct 6 19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
@@ -23,16 +24,32 @@
$GLOBALS['log4php.LoggerMDC.ht'] = array();
/**
- * The LoggerMDC class is similar to the {...@link LoggerNDC} class except
that it is
- * based on a map instead of a stack. It provides <i>mapped diagnostic
contexts</i>.
+ * The LoggerMDC class provides <i>mapped diagnostic contexts</i>.
*
- * A <i>Mapped Diagnostic Context</i>, or
+ * <p>A <i>Mapped Diagnostic Context</i>, or
* MDC in short, is an instrument for distinguishing interleaved log
* output from different sources. Log output is typically interleaved
* when a server handles multiple clients near-simultaneously.
*
+ * <p>This class is similar to the {...@link LoggerNDC} class except that
+ * it is based on a map instead of a stack.
+ *
* <p><b><i>The MDC is managed on a per thread basis</i></b>.
*
+ * Example:
+ *
+ * {...@example ../../examples/php/mdc.php}<br>
+ *
+ * With the properties file:
+ *
+ * {...@example ../../examples/resources/mdc.properties}<br>
+ *
+ * Will result in the following (notice the username "knut" in the output):
+ *
+ * <pre>
+ * 2009-09-13 18:48:28 DEBUG root knut: Testing MDC in
src/examples/php/mdc.php at 23
+ * </pre>
+ *
* @version $Revision$
* @since 0.3
* @package log4php
Modified: incubator/log4php/trunk/src/main/php/LoggerNDC.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerNDC.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerNDC.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerNDC.php Tue Oct 6 19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
@@ -24,8 +25,9 @@
$GLOBALS['log4php.LoggerNDC.ht'] = array();
/**
- * The NDC class implements <i>nested diagnostic contexts</i> as
- * defined by Neil Harrison in the article "Patterns for Logging
+ * The NDC class implements <i>nested diagnostic contexts</i>.
+ *
+ * NDC was defined by Neil Harrison in the article "Patterns for Logging
* Diagnostic Messages" part of the book "<i>Pattern Languages of
* Program Design 3</i>" edited by Martin et al.
*
@@ -34,6 +36,9 @@
* output is typically interleaved when a server handles multiple
* clients near-simultaneously.
*
+ * <p>This class is similar to the {...@link LoggerMDC} class except that it is
+ * based on a stack instead of a map.
+ *
* <p>Interleaved log output can still be meaningful if each log entry
* from different contexts had a distinctive stamp. This is where NDCs
* come into play.
@@ -74,6 +79,22 @@
* the same category) can still be distinguished because each client
* request will have a different NDC tag.</p>
*
+ * Example:
+ *
+ * {...@example ../../examples/php/ndc.php}<br>
+ *
+ * With the properties file:
+ *
+ * {...@example ../../examples/resources/ndc.properties}<br>
+ *
+ * Will result in the following (notice the conn and client ids):
+ *
+ * <pre>
+ * 2009-09-13 19:04:27 DEBUG root conn=1234: just received a new connection in
src/examples/php/ndc.php at 23
+ * 2009-09-13 19:04:27 DEBUG root conn=1234 client=ab23: some more messages
that can in src/examples/php/ndc.php at 25
+ * 2009-09-13 19:04:27 DEBUG root conn=1234 client=ab23: now related to a
client in src/examples/php/ndc.php at 26
+ * 2009-09-13 19:04:27 DEBUG root : back and waiting for new connections in
src/examples/php/ndc.php at 29
+ * </pre>
*
* @version $Revision$
* @package log4php
Modified: incubator/log4php/trunk/src/main/php/LoggerReflectionUtils.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerReflectionUtils.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerReflectionUtils.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerReflectionUtils.php Tue Oct 6
19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
Modified: incubator/log4php/trunk/src/main/php/LoggerRoot.php
URL:
http://svn.apache.org/viewvc/incubator/log4php/trunk/src/main/php/LoggerRoot.php?rev=822448&r1=822447&r2=822448&view=diff
==============================================================================
--- incubator/log4php/trunk/src/main/php/LoggerRoot.php (original)
+++ incubator/log4php/trunk/src/main/php/LoggerRoot.php Tue Oct 6 19:23:53 2009
@@ -15,6 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
+ * @package log4php
*/
/**
