[pLog-svn] r1473 - in plog/trunk/class/logger: . appender config
layout logger
oscar at devel.plogworld.net
oscar at devel.plogworld.net
Mon Mar 14 23:13:27 GMT 2005
Author: oscar
Date: 2005-03-14 23:13:27 +0000 (Mon, 14 Mar 2005)
New Revision: 1473
Modified:
plog/trunk/class/logger/LogUtil.php
plog/trunk/class/logger/appender/appender.class.php
plog/trunk/class/logger/appender/fileappender.class.php
plog/trunk/class/logger/appender/nullappender.class.php
plog/trunk/class/logger/appender/stdoutappender.class.php
plog/trunk/class/logger/config/loggerconfigloader.class.php
plog/trunk/class/logger/layout/layout.class.php
plog/trunk/class/logger/layout/patternlayout.class.php
plog/trunk/class/logger/logger/loggedmessage.class.php
plog/trunk/class/logger/loggermanager.class.php
Log:
started cleaning up the documentation
Modified: plog/trunk/class/logger/LogUtil.php
===================================================================
--- plog/trunk/class/logger/LogUtil.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/LogUtil.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -2,7 +2,7 @@
/**
* Logger helper class
* @author Su Baochen <subaochen at 126.com>
- * @package logger
+ * \ingroup logger
*/
class LogUtil{
/**
Modified: plog/trunk/class/logger/appender/appender.class.php
===================================================================
--- plog/trunk/class/logger/appender/appender.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/appender/appender.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -1,13 +1,14 @@
<?php
/**
- * qAppender allows you to log messags to any location. Every appender has its own layout
+ * Appender allows you to log messags to any location. Every appender has its own layout
* that specifies the format of the messages, and every appender has a target location for messages.
* This way, we can have an appender that writes log messages to a database, another one that writes
* messages to a file, etc.
*
* @see LoggerManager
* @see Logger
+ * \ingroup logger
*/
class Appender
{
Modified: plog/trunk/class/logger/appender/fileappender.class.php
===================================================================
--- plog/trunk/class/logger/appender/fileappender.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/appender/fileappender.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -1,12 +1,10 @@
<?php
- /**
- * @package logger
- */
-
include_once( PLOG_CLASS_PATH."class/logger/appender/appender.class.php" );
/**
+ * \ingroup logger
+ *
* FileAppender allows a logger to write a message to file.
*/
class FileAppender extends Appender
Modified: plog/trunk/class/logger/appender/nullappender.class.php
===================================================================
--- plog/trunk/class/logger/appender/nullappender.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/appender/nullappender.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -5,7 +5,7 @@
/**
* Dummy appender that does nothing.
*
- * @package logger
+ * \ingroup logger
*/
class NullAppender extends Appender
{
Modified: plog/trunk/class/logger/appender/stdoutappender.class.php
===================================================================
--- plog/trunk/class/logger/appender/stdoutappender.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/appender/stdoutappender.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -5,7 +5,7 @@
/**
* StdoutAppender logs a message directly to the requesting client.
*
- * @package logger
+ * \ingroup logger
*/
class StdoutAppender extends Appender
{
Modified: plog/trunk/class/logger/config/loggerconfigloader.class.php
===================================================================
--- plog/trunk/class/logger/config/loggerconfigloader.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/config/loggerconfigloader.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -8,6 +8,8 @@
* loads the config file of the logger. By default it uses config/logging.properties.php
* as the config file. See the documentation for the LoggerManager for more details on how
* the configuration file should be laid out.
+ *
+ * \ingroup logger
*/
class LoggerConfigLoader
{
Modified: plog/trunk/class/logger/layout/layout.class.php
===================================================================
--- plog/trunk/class/logger/layout/layout.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/layout/layout.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -2,10 +2,6 @@
include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
- /**
- * @package logger
- */
-
/**
* Layout provides a customizable way to format data for an appender. A Layout specifies
* the format of the messages that are going to be written to a target via an appender.
@@ -13,6 +9,7 @@
* @see Appender
* @see Logger
* @see LoggerManager
+ * \ingroup logger
*/
class Layout
{
Modified: plog/trunk/class/logger/layout/patternlayout.class.php
===================================================================
--- plog/trunk/class/logger/layout/patternlayout.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/layout/patternlayout.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -6,7 +6,7 @@
* PatternLayout allows a completely customizable layout that uses a conversion
* pattern for formatting.
*
- * @package logger
+ * \ingroup logger
*/
class PatternLayout extends Layout
{
Modified: plog/trunk/class/logger/logger/loggedmessage.class.php
===================================================================
--- plog/trunk/class/logger/logger/loggedmessage.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/logger/loggedmessage.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -6,7 +6,7 @@
* LoggedMessage contains information about a log message such as priority, text
* etc...
*
- * @package logger
+ * \ingroup logger
*/
class LoggedMessage
{
Modified: plog/trunk/class/logger/loggermanager.class.php
===================================================================
--- plog/trunk/class/logger/loggermanager.class.php 2005-03-14 22:48:14 UTC (rev 1472)
+++ plog/trunk/class/logger/loggermanager.class.php 2005-03-14 23:13:27 UTC (rev 1473)
@@ -5,7 +5,21 @@
include_once( PLOG_CLASS_PATH."class/logger/layout/patternlayout.class.php" );
/**
- * manages a bunch of loggers configured in the config/logging.properties.php file. By default if no loggers
+ * \defgroup logger
+ *
+ * The logger package takes care of providing logging facilities for the pLog API. It is a very simple
+ * API but on the other hand, it follows some of the principles establishes by log4j and log4php, with
+ * a very similar system of layouts, formatters and appenders.
+ *
+ * See the documentation of the LoggerManager class for more information on how to use the class and how
+ * to format the messages
+ */
+
+ /**
+ *
+ * \ingroup logger
+ *
+ * The logger manages a bunch of loggers configured in the config/logging.properties.php file. By default if no loggers
* are specified it will create one logger called "default".
* In order to define new loggers, the configuration file has to look like this:
*
More information about the pLog-svn
mailing list