You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4cxx-dev@logging.apache.org by ca...@apache.org on 2008/02/20 05:21:51 UTC

svn commit: r629346 [1/4] - in /logging/log4cxx/trunk: ./ src/assembly/ src/changes/ src/main/cpp/ src/main/include/log4cxx/ src/main/include/log4cxx/config/ src/main/include/log4cxx/filter/ src/main/include/log4cxx/helpers/ src/main/include/log4cxx/ne...

Author: carnold
Date: Tue Feb 19 20:21:39 2008
New Revision: 629346

URL: http://svn.apache.org/viewvc?rev=629346&view=rev
Log:
LOGCXX-62: Doxygen fixes, rename thread to avoid object file collision

Added:
    logging/log4cxx/trunk/src/main/cpp/threadcxx.cpp
      - copied unchanged from r628570, logging/log4cxx/trunk/src/main/cpp/thread.cpp
    logging/log4cxx/trunk/src/site/doxy/license_notice_footer.txt
    logging/log4cxx/trunk/src/site/resources/
      - copied from r628387, logging/log4j/trunk/src/site/resources/
    logging/log4cxx/trunk/src/site/resources/css/
      - copied from r629345, logging/log4j/trunk/src/site/resources/css/
    logging/log4cxx/trunk/src/site/resources/images/
      - copied from r629345, logging/log4j/trunk/src/site/resources/images/
Removed:
    logging/log4cxx/trunk/src/main/cpp/thread.cpp
    logging/log4cxx/trunk/src/site/apt/roadmap.apt
    logging/log4cxx/trunk/src/site/resources/images/logo.jpg
    logging/log4cxx/trunk/src/site/xdoc/manual.xml
    logging/log4cxx/trunk/src/site/xdoc/news.xml
    logging/log4cxx/trunk/src/site/xdoc/performance.xml
Modified:
    logging/log4cxx/trunk/build.xml
    logging/log4cxx/trunk/src/assembly/source.xml
    logging/log4cxx/trunk/src/changes/changes.xslt
    logging/log4cxx/trunk/src/main/cpp/Makefile.am
    logging/log4cxx/trunk/src/main/include/log4cxx/asyncappender.h
    logging/log4cxx/trunk/src/main/include/log4cxx/config/propertysetter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h
    logging/log4cxx/trunk/src/main/include/log4cxx/file.h
    logging/log4cxx/trunk/src/main/include/log4cxx/fileappender.h
    logging/log4cxx/trunk/src/main/include/log4cxx/filter/andfilter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/filter/expressionfilter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/filter/locationinfofilter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/bytearrayinputstream.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cacheddateformat.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetdecoder.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetencoder.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/condition.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/dateformat.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/datetimedateformat.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/fileinputstream.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/properties.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/simpledateformat.h
    logging/log4cxx/trunk/src/main/include/log4cxx/helpers/strftimedateformat.h
    logging/log4cxx/trunk/src/main/include/log4cxx/hierarchy.h
    logging/log4cxx/trunk/src/main/include/log4cxx/level.h
    logging/log4cxx/trunk/src/main/include/log4cxx/logger.h
    logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h
    logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h
    logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h
    logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h
    logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappenderskeleton.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/classnamepatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/datepatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filedatepatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/filelocationpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/fulllocationpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/integerpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/levelpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/linelocationpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/lineseparatorpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/literalpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/loggerpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/loggingeventpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/messagepatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/methodlocationpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/namepatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/ndcpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternparser.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/propertiespatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/relativetimepatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/threadpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/pattern/throwableinformationpatternconverter.h
    logging/log4cxx/trunk/src/main/include/log4cxx/propertyconfigurator.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/action.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingfileappender.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingpolicy.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingpolicybase.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rolloverdescription.h
    logging/log4cxx/trunk/src/main/include/log4cxx/rolling/timebasedrollingpolicy.h
    logging/log4cxx/trunk/src/main/include/log4cxx/spi/loggingevent.h
    logging/log4cxx/trunk/src/main/include/log4cxx/stream.h
    logging/log4cxx/trunk/src/main/include/log4cxx/ttcclayout.h
    logging/log4cxx/trunk/src/main/include/log4cxx/writerappender.h
    logging/log4cxx/trunk/src/site/apt/building/ant.apt
    logging/log4cxx/trunk/src/site/apt/building/autotools.apt
    logging/log4cxx/trunk/src/site/apt/building/maven.apt
    logging/log4cxx/trunk/src/site/apt/building/vstudio.apt
    logging/log4cxx/trunk/src/site/apt/building/xcode.apt
    logging/log4cxx/trunk/src/site/apt/download.apt
    logging/log4cxx/trunk/src/site/doxy/Doxyfile.in
    logging/log4cxx/trunk/src/site/fml/faq.fml
    logging/log4cxx/trunk/src/site/site.xml
    logging/log4cxx/trunk/src/site/xdoc/index.xml

Modified: logging/log4cxx/trunk/build.xml
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/build.xml?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/build.xml (original)
+++ logging/log4cxx/trunk/build.xml Tue Feb 19 20:21:39 2008
@@ -27,7 +27,7 @@
       <libset libs="${odbc.lib}" if="odbc.lib"/>
       <libset libs="${apr-util.dependencies}" if="apr-util.dependencies"/>
         <libset libs="pthread" if="is-unix"/>
-        <syslibset libs="advapi32 ws2_32 mswsock shell32" if="is-windows"/>
+        <syslibset libs="advapi32 ws2_32 shell32" if="is-windows"/>
         <syslibset libs="stdc++" if="is-gcc"/>
         <syslibset libs="cw32mt" if="is-bcc"/>
 '>
@@ -1063,7 +1063,7 @@
     <exec executable="sed">
         <arg value="-i"/>
         <arg value="-e"/>
-        <arg value="s~ADD LINK32 .*/NOLOGO~ADD LINK32 static\\aprutil-1.lib static\\apr-1.lib ADVAPI32.LIB MSWSOCK.LIB WS2_32.LIB SHELL32.LIB ODBC32.LIB /NOLOGO~g"/>
+        <arg value="s~ADD LINK32 .*/NOLOGO~ADD LINK32 ADVAPI32.LIB WS2_32.LIB SHELL32.LIB ODBC32.LIB /NOLOGO~g"/>
         <arg value="${project.dsp}"/>
     </exec>
 </target>
@@ -1072,32 +1072,23 @@
     <exec executable="sed">
         <arg value="-i"/>
         <arg value="-e"/>
-        <arg value="s~ADD LINK32 .*/NOLOGO~ADD LINK32 shared\\log4cxx.lib static\\aprutil-1.lib static\\apr-1.lib ADVAPI32.LIB MSWSOCK.LIB WS2_32.LIB SHELL32.LIB ODBC32.LIB /NOLOGO~g"/>
+        <arg value="s~ADD LINK32 .*/NOLOGO~ADD LINK32 ADVAPI32.LIB WS2_32.LIB SHELL32.LIB ODBC32.LIB /NOLOGO~g"/>
         <arg value="${project.dsp}"/>
     </exec>
 </target>
 
-<target name="patch-vc7-log4cxx">
+<target name="patch-vc6-dsw">
     <exec executable="sed">
         <arg value="-i"/>
-        <arg value=".bak"/>
         <arg value="-e"/>
-        <arg value='s~AdditionalDependencies=".*"~~'/>
-        <arg value="-e"/>
-        <arg value='s~Name="VCLinkerTool"~Name="VCLinkerTool" AdditionalDependencies="static\\aprutil-1.lib static\\apr-1.lib ADVAPI32.LIB MSWSOCK.LIB WS2_32.LIB SHELL32.LIB ODBC32.LIB"~'/>
-        <arg value="${project.dsp}"/>
+        <arg value="s~.\apr.dsp~..\..\apr\apr.dsp~g"/>
+        <arg value="${project.dsw}"/>
     </exec>
-</target>
-
-<target name="patch-vc7-sample">
     <exec executable="sed">
         <arg value="-i"/>
-        <arg value=".bak"/>
-        <arg value="-e"/>
-        <arg value='s~AdditionalDependencies=".*"~~'/>
         <arg value="-e"/>
-        <arg value='s~Name="VCLinkerTool"~Name="VCLinkerTool" AdditionalDependencies="shared\\log4cxx.lib static\\aprutil-1.lib static\\apr-1.lib ADVAPI32.LIB MSWSOCK.LIB WS2_32.LIB SHELL32.LIB ODBC32.LIB"~'/>
-        <arg value="${project.dsp}"/>
+        <arg value="s~.\apr-util.dsp~..\..\apr-util\apr-util.dsp~g"/>
+        <arg value="${project.dsw}"/>
     </exec>
 </target>
 
@@ -1107,9 +1098,6 @@
     <antcall target="build-projects-vc6">
         <param name="find" value="false"/>
     </antcall>
-    <antcall target="build-projects-vc7">
-        <param name="find" value="false"/>
-    </antcall>
     <antcall target="build-projects-xcode"/>
     <taskdef name="foreach" classname="net.sf.antcontrib.logic.ForEach" />
     
@@ -1119,11 +1107,8 @@
     <foreach target="patch-vc6-log4cxx" param="project.dsp">
         <path><fileset dir="${target.dir}" includes="**/log4cxx.dsp **/testsuite-standalone.dsp"/></path>
     </foreach>
-    <foreach target="patch-vc7-sample" param="project.dsp">
-        <path><fileset dir="${target.dir}" includes="**/*.vcproj"/></path>
-    </foreach>
-    <foreach target="patch-vc7-log4cxx" param="project.dsp">
-        <path><fileset dir="${target.dir}" includes="**/log4cxx.vcproj **/testsuite-standalone.vcproj"/></path>
+    <foreach target="patch-vc6-dsw" param="project.dsw">
+        <path><fileset dir="${target.dir}" includes="**/*.dsw"/></path>
     </foreach>
     
 </target>

Modified: logging/log4cxx/trunk/src/assembly/source.xml
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/assembly/source.xml?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/assembly/source.xml (original)
+++ logging/log4cxx/trunk/src/assembly/source.xml Tue Feb 19 20:21:39 2008
@@ -71,7 +71,6 @@
             <includes>
             <include>*.dsw</include>
             <include>*.dsp</include>
-            <include>*.vsproj</include>
             <include>*.xcodeproj/**</include>
             </includes>
         </fileSet>

Modified: logging/log4cxx/trunk/src/changes/changes.xslt
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/changes/changes.xslt?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/changes/changes.xslt (original)
+++ logging/log4cxx/trunk/src/changes/changes.xslt Tue Feb 19 20:21:39 2008
@@ -46,7 +46,7 @@
   </properties>
   <body>
   
-    <release version="0.10.0" date="2007-07-30" description="First Apache release">
+    <release version="0.10.0" date="2008-02-29" description="First Apache release">
        <xsl:apply-templates select='/rss/channel/item'>
            <xsl:sort select="substring-after(key, '-')" data-type="number"/>
        </xsl:apply-templates>

Modified: logging/log4cxx/trunk/src/main/cpp/Makefile.am
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/cpp/Makefile.am?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/cpp/Makefile.am (original)
+++ logging/log4cxx/trunk/src/main/cpp/Makefile.am Tue Feb 19 20:21:39 2008
@@ -150,7 +150,7 @@
         systemerrwriter.cpp \
         systemoutwriter.cpp \
         telnetappender.cpp \
-        thread.cpp \
+        threadcxx.cpp \
         threadlocal.cpp \
         threadspecificdata.cpp \
         threadpatternconverter.cpp \

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/asyncappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/asyncappender.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/asyncappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/asyncappender.h Tue Feb 19 20:21:39 2008
@@ -82,9 +82,6 @@
                 */
                 void addAppender(const AppenderPtr& newAppender);
 
-                /**
-                 * {@inheritDoc}
-                 */
                 void append(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p);
 
                 /**
@@ -122,9 +119,6 @@
                 */
                 bool isAttached(const AppenderPtr& appender) const;
 
-                /**
-                 * {@inheritDoc}
-                */
                 virtual bool requiresLayout() const;
                     
                 /**

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/config/propertysetter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/config/propertysetter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/config/propertysetter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/config/propertysetter.h Tue Feb 19 20:21:39 2008
@@ -72,6 +72,7 @@
                         @param obj The object to configure.
                         @param properties A java.util.Properties containing keys and values.
                         @param prefix Only keys having the specified prefix will be set.
+                        @param p pool to use for any allocations required during call.
                         */
                         static void setProperties(const helpers::ObjectPtr& obj,
                                 helpers::Properties& properties,
@@ -91,8 +92,9 @@
                         Object supports the spi::OptionHandler interface, the
                         {@link spi::OptionHandler#setOption setOption} method is called.
 
-                        @param name    name of the property
+                        @param option   name of the property
                         @param value   String value of the property
+                        @param p pool to use for any allocations required during call.
                         */
                         void setProperty(const LogString& option,
                             const LogString& value,

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h Tue Feb 19 20:21:39 2008
@@ -41,15 +41,105 @@
 
 
 /**
-  * org.apache.log4j.DailyRollingFileAppender emulates earlier implementations
-  * by delegating to general purpose org.apache.log4j.rollling.RollingFileAppender
-  * introduced in log4j 1.3.  This class is provided for compatibility with
-  *  existing code and should not be used except when compatibility with version
-  * of log4j prior to 1.3 is a concern.
-  *
-  *  
-  * @deprecated Replaced by {@link org.apache.log4j.rolling.RollingFileAppender}
+   DailyRollingFileAppender extends {@link FileAppender} so that the
+   underlying file is rolled over at a user chosen frequency.
+
+   <p>The rolling schedule is specified by the <b>DatePattern</b>
+   option. This pattern should follow the 
+   {@link log4cxx::helpers::SimpleDateFormat SimpleDateFormat}
+   conventions. In particular, you <em>must</em> escape literal text
+   within a pair of single quotes. A formatted version of the date
+   pattern is used as the suffix for the rolled file name.
+
+   <p>For example, if the <b>File</b> option is set to
+   <code>/foo/bar.log</code> and the <b>DatePattern</b> set to
+   <code>'.'yyyy-MM-dd</code>, on 2001-02-16 at midnight, the logging
+   file <code>/foo/bar.log</code> will be copied to
+   <code>/foo/bar.log.2001-02-16</code> and logging for 2001-02-17
+   will continue in <code>/foo/bar.log</code> until it rolls over
+   the next day.
+
+   <p>Is is possible to specify monthly, weekly, half-daily, daily,
+   hourly, or minutely rollover schedules.
+
+   <p><table border="1" cellpadding="2">
+   <tr>
+   <th>DatePattern</th>
+   <th>Rollover schedule</th>
+   <th>Example</th>
+
+   <tr>
+   <td><code>'.'yyyy-MM</code>
+   <td>Rollover at the beginning of each month</td>
+
+   <td>At midnight of May 31st, 2002 <code>/foo/bar.log</code> will be
+   copied to <code>/foo/bar.log.2002-05</code>. Logging for the month
+   of June will be output to <code>/foo/bar.log</code> until it is
+   also rolled over the next month.
+
+   <tr>
+   <td><code>'.'yyyy-ww</code>
+
+   <td>Rollover at the first day of each week. The first day of the
+   week depends on the locale.</td>
+
+   <td>Assuming the first day of the week is Sunday, on Saturday
+   midnight, June 9th 2002, the file <i>/foo/bar.log</i> will be
+   copied to <i>/foo/bar.log.2002-23</i>.  Logging for the 24th week
+   of 2002 will be output to <code>/foo/bar.log</code> until it is
+   rolled over the next week.
+
+   <tr>
+   <td><code>'.'yyyy-MM-dd</code>
+
+   <td>Rollover at midnight each day.</td>
+
+   <td>At midnight, on March 8th, 2002, <code>/foo/bar.log</code> will
+   be copied to <code>/foo/bar.log.2002-03-08</code>. Logging for the
+   9th day of March will be output to <code>/foo/bar.log</code> until
+   it is rolled over the next day.
+
+   <tr>
+   <td><code>'.'yyyy-MM-dd-a</code>
+
+   <td>Rollover at midnight and midday of each day.</td>
+
+   <td>At noon, on March 9th, 2002, <code>/foo/bar.log</code> will be
+   copied to <code>/foo/bar.log.2002-03-09-AM</code>. Logging for the
+   afternoon of the 9th will be output to <code>/foo/bar.log</code>
+   until it is rolled over at midnight.
+
+   <tr>
+   <td><code>'.'yyyy-MM-dd-HH</code>
+
+   <td>Rollover at the top of every hour.</td>
+
+   <td>At approximately 11:00.000 o'clock on March 9th, 2002,
+   <code>/foo/bar.log</code> will be copied to
+   <code>/foo/bar.log.2002-03-09-10</code>. Logging for the 11th hour
+   of the 9th of March will be output to <code>/foo/bar.log</code>
+   until it is rolled over at the beginning of the next hour.
+
+
+   <tr>
+   <td><code>'.'yyyy-MM-dd-HH-mm</code>
+
+   <td>Rollover at the beginning of every minute.</td>
+
+   <td>At approximately 11:23,000, on March 9th, 2001,
+   <code>/foo/bar.log</code> will be copied to
+   <code>/foo/bar.log.2001-03-09-10-22</code>. Logging for the minute
+   of 11:23 (9th of March) will be output to
+   <code>/foo/bar.log</code> until it is rolled over the next minute.
+
+   </table>
+
+   <p>Do not use the colon ":" character in anywhere in the
+   <b>DatePattern</b> option. The text before the colon is interpeted
+   as the protocol specificaion of a URL which is probably not what
+   you want.
 */
+
   class LOG4CXX_EXPORT DailyRollingFileAppender : public log4cxx::rolling::RollingFileAppenderSkeleton {
   DECLARE_LOG4CXX_OBJECT(DailyRollingFileAppender)
   BEGIN_LOG4CXX_CAST_MAP()
@@ -83,7 +173,7 @@
 
   /**
      The <b>DatePattern</b> takes a string in the same format as
-     expected by {@link java.text.SimpleDateFormat}. This options determines the
+     expected by {@link log4cxx::helpers::SimpleDateFormat SimpleDateFormat}. This options determines the
      rollover schedule.
    */
   void setDatePattern(const LogString& pattern);

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/file.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/file.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/file.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/file.h Tue Feb 19 20:21:39 2008
@@ -39,40 +39,140 @@
                 class LOG4CXX_EXPORT File
                 {
                 public:
+                    /**
+                    *   Construct a new instance.
+                    */
                     File();
-                    File(const char* name);
-                    File(const std::string& name);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path in local encoding.
+                    */
+                    File(const char* path);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path in current encoding.
+                    */
+                    File(const std::string& path);
 #if LOG4CXX_WCHAR_T_API
-                    File(const wchar_t* name);
-                    File(const std::wstring& name);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path.
+                    */
+                    File(const wchar_t* path);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path.
+                    */
+                    File(const std::wstring& path);
 #endif
 #if LOG4CXX_UNICHAR_API
-                    File(const UniChar* name);
-                    File(const std::basic_string<UniChar>& name);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path.
+                    */
+                    File(const UniChar* path);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path.
+                    */
+                    File(const std::basic_string<UniChar>& path);
 #endif
 #if LOG4CXX_CFSTRING_API
-                    File(const CFStringRef& name);
+                    /**
+                    *   Construct a new instance.  Use setPath to specify path using a LogString.
+                    * @param path file path.
+                    */
+                    File(const CFStringRef& path);
 #endif
+                    /**
+                     *  Copy constructor.
+                     */
                     File(const File& src);
+                    /**
+                     *  Assignment operator.
+                     */ 
                     File& operator=(const File& src);
+                    /**
+                     *  Destructor.
+                     */
                     ~File();
                     
+                    /**
+                     *  Determines if file exists.
+                     *  @param p pool.
+                     *  @return true if file exists.
+                     */
                     bool exists(log4cxx::helpers::Pool& p) const;
+                    /**
+                     *  Determines length of file.  May not be accurate if file is current open.
+                     *  @param p pool.
+                     *  @return length of file.
+                     */
                     size_t length(log4cxx::helpers::Pool& p) const;
+                    /**
+                     *  Determines last modification date.
+                     *  @param p pool.
+                     *  @return length of file.
+                     */
                     log4cxx_time_t lastModified(log4cxx::helpers::Pool& p) const;
+                    /**
+                     *  Get final portion of file path.
+                     *  @return file name.
+                     */
                     LogString getName() const;
+                    /**
+                     *  Get file path.
+                     *  @return file path.
+                     */
                     LogString getPath() const;
+                    /**
+                     *  Set file path
+                     */
                     File& setPath(const LogString&);
 
+                    /**
+                     *  Open file.  See apr_file_open for details.
+                     *  @param file APR file handle.
+                     *  @param flags flags.
+                     *  @param perm permissions.
+                     *  @param p pool.
+                     *  @return APR_SUCCESS if successful.
+                     */
                     log4cxx_status_t open(apr_file_t** file, int flags,
                           int perm, log4cxx::helpers::Pool& p) const;
 
+                    /**
+                     *   List files if current file is a directory.
+                     *   @param p pool.
+                     *   @return list of files in this directory, operation of non-directory returns empty list.
+                     */
                     std::vector<LogString> list(log4cxx::helpers::Pool& p) const;
 
+                    /**
+                     *   Delete file.
+                     *   @param p pool.
+                     *   @return true if file successfully deleted.
+                     */
                     bool deleteFile(log4cxx::helpers::Pool& p) const;
+                    /**
+                     *   Rename file.
+                     *   @param dest new path for file.
+                     *   @param p pool.
+                     *   @return true if file successfully renamed.
+                     */
                     bool renameTo(const File& dest, log4cxx::helpers::Pool& p) const;
                     
+                    /**
+                     *   Get path of parent directory.
+                     *   @param p pool.
+                     *   @return path of parent directory.
+                     */
                     LogString getParent(log4cxx::helpers::Pool& p) const;
+                    /**
+                     *  Make directories recursively.
+                     *  @param p pool.
+                     *  @return true if all requested directories existed or have been created.
+                     */
                     bool mkdirs(log4cxx::helpers::Pool& p) const;
 
                 private:

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/fileappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/fileappender.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/fileappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/fileappender.h Tue Feb 19 20:21:39 2008
@@ -137,6 +137,7 @@
                 truncate fileName.
                 @param bufferedIO Do we do bufferedIO?
                 @param bufferSize How big should the IO buffer be?
+                @param p memory pool for operation.
                 */
                 virtual void setFile(const LogString& file, bool append,
                         bool bufferedIO, size_t bufferSize,

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/filter/andfilter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/filter/andfilter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/filter/andfilter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/filter/andfilter.h Tue Feb 19 20:21:39 2008
@@ -34,31 +34,31 @@
 /**
  * A filter that 'and's the results of any number of contained filters together.
  *
- * For the filter to process events, all contained filters must return Filter.ACCEPT.
+ * For the filter to process events, all contained filters must return Filter::ACCEPT.
  *
- * If the contained filters do not return Filter.ACCEPT, Filter.NEUTRAL is returned.
+ * If the contained filters do not return Filter::ACCEPT, Filter::NEUTRAL is returned.
  *
- * If acceptOnMatch is set to true, Filter.ACCEPT is returned.
- * If acceptOnMatch is set to false, Filter.DENY is returned.
+ * If acceptOnMatch is set to true, Filter::ACCEPT is returned.
+ * If acceptOnMatch is set to false, Filter::DENY is returned.
  *
  * Here is an example config that will accept only events that contain BOTH
  * a DEBUG level AND 'test' in the message:
  *
- *<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
- * <filter class="org.apache.log4j.filter.AndFilter">
- *  <filter class="org.apache.log4j.filter.LevelMatchFilter">
- *        <param name="levelToMatch" value="DEBUG" />
- *        <param name="acceptOnMatch" value="true" />
- *  </filter>
- *  <filter class="org.apache.log4j.filter.StringMatchFilter">
- *        <param name="stringToMatch" value="test" />
- *        <param name="acceptOnMatch" value="true" />
- *  </filter>
- *  <param name="acceptOnMatch" value="false"/>
- * </filter>
- * <filter class="org.apache.log4j.filter.DenyAllFilter"/>
- *<layout class="org.apache.log4j.SimpleLayout"/>
- *</appender>
+ *&lt;appender name="STDOUT" class="org.apache.log4j.ConsoleAppender"&gt;
+ * &lt;filter class="org.apache.log4j.filter.AndFilter"&gt;
+ *  &lt;filter class="org.apache.log4j.filter.LevelMatchFilter"&gt;
+ *        &lt;param name="levelToMatch" value="DEBUG" /&gt;
+ *        &lt;param name="acceptOnMatch" value="true" /&gt;
+ *  &lt;/filter>
+ *  &lt;filter class="org.apache.log4j.filter.StringMatchFilter"&gt;
+ *        &lt;param name="stringToMatch" value="test" /&gt;
+ *        &lt;param name="acceptOnMatch" value="true" /&gt;
+ *  &lt;/filter>
+ *  &lt;param name="acceptOnMatch" value="false"/&gt;
+ * &lt;/filter&gt;
+ * &lt;filter class="org.apache.log4j.filter.DenyAllFilter"/&gt;
+ *&lt;layout class="org.apache.log4j.SimpleLayout"/&gt;
+ *&lt;/appender&gt;
  *
  * To accept all events EXCEPT those events that contain a
  * DEBUG level and 'test' in the message:
@@ -96,15 +96,6 @@
 
             void setAcceptOnMatch(bool acceptOnMatch);
 
-  /**
-   * If this event does not already contain location information,
-   * evaluate the event against the expression.
-   *
-   * If the expression evaluates to true, generate a LocationInfo instance
-   * by creating an exception and set this LocationInfo on the event.
-   *
-   * Returns {@link Filter#NEUTRAL}
-   */
             FilterDecision decide(const spi::LoggingEventPtr & event) const;
         };
 

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/filter/expressionfilter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/filter/expressionfilter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/filter/expressionfilter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/filter/expressionfilter.h Tue Feb 19 20:21:39 2008
@@ -47,7 +47,7 @@
  * <p>See <code>org.apache.log4j.chainsaw.LoggingEventFieldResolver.java</code>
  * for the correct names for logging event fields used when building expressions.
  *
- * <p>See <org.apache.log4j.chainsaw.rule</code> package for a list of available
+ * <p>See <code>org.apache.log4j.chainsaw.rule</code> package for a list of available
  * rules which can be applied using the expression syntax.
  *
  * <p>See <code>org.apache.log4j.chainsaw.RuleFactory</code> for the symbols
@@ -70,14 +70,14 @@
  *
  * Meaning of <b>AcceptToMatch</b>:
  * If there is a match between the value of the
- * Expression option and the {@link LoggingEvent} and AcceptOnMatch is true,
- * the {@link #decide} method returns {@link Filter#ACCEPT}.
+ * Expression option and the {@link log4cxx::spi::LoggingEvent} and AcceptOnMatch is true,
+ * the {@link #decide} method returns {@link log4cxx::spi::Filter#ACCEPT}.
  *
  * If there is a match between the value of the
- * Expression option and the {@link LoggingEvent} and AcceptOnMatch is false,
- * {@link Filter#DENY} is returned.
+ * Expression option and the {@link log4cxx::spi::LoggingEvent} and AcceptOnMatch is false,
+ * {@link log4cxx::spi::Filter#DENY} is returned.
  *
- * If there is no match, {@link Filter#NEUTRAL} is returned.
+ * If there is no match, {@link log4cxx::spi::Filter#NEUTRAL} is returned.
  *
  * 
  */
@@ -115,7 +115,7 @@
             bool getAcceptOnMatch() const;
 
   /**
-     Returns {@link Filter#NEUTRAL} is there is no string match.
+     Returns {@link log4cxx::spi::Filter#NEUTRAL} is there is no string match.
    */
             FilterDecision decide(const spi::LoggingEventPtr & event) const;
         };

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/filter/locationinfofilter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/filter/locationinfofilter.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/filter/locationinfofilter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/filter/locationinfofilter.h Tue Feb 19 20:21:39 2008
@@ -77,7 +77,7 @@
    * If the expression evaluates to true, generate a LocationInfo instance
    * by creating an exception and set this LocationInfo on the event.
    *
-   * Returns {@link Filter#NEUTRAL}
+   * Returns {@link log4cxx::spi::Filter#NEUTRAL}
    */
             FilterDecision decide(const spi::LoggingEventPtr & event) const;
 

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/bytearrayinputstream.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/bytearrayinputstream.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/bytearrayinputstream.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/bytearrayinputstream.h Tue Feb 19 20:21:39 2008
@@ -68,7 +68,7 @@
                   /**
                    * Reads a sequence of bytes into the given buffer.
                    *
-                   * @param dst The buffer into which bytes are to be transferred.
+                   * @param buf The buffer into which bytes are to be transferred.
                    * @return the total number of bytes read into the buffer, or -1 if there
                    *         is no more data because the end of the stream has been reached.
                    */

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cacheddateformat.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cacheddateformat.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cacheddateformat.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cacheddateformat.h Tue Feb 19 20:21:39 2008
@@ -127,6 +127,7 @@
              * @param time long time, must be integral number of seconds
              * @param formatted String corresponding formatted string
              * @param formatter DateFormat date format
+             * @param pool pool.
              * @return int position in string of first digit of milliseconds,
              *    -1 indicates no millisecond field, -2 indicates unrecognized
              *    field (likely RelativeTimeDateFormat)
@@ -141,7 +142,7 @@
              *
              *  @param date the date to format.
              *  @param sbuf the string buffer to write to.
-             *  @param pool memory pool.
+             *  @param p memory pool.
              */
                virtual void format(LogString &sbuf,
                    log4cxx_time_t date,
@@ -166,7 +167,7 @@
                 *
                 * @remarks Setting the timezone using getCalendar().setTimeZone()
                 * will likely cause caching to misbehave.
-                * @param timeZone TimeZone new timezone
+                * @param zone TimeZone new timezone
                 */
                virtual void setTimeZone(const log4cxx::helpers::TimeZonePtr& zone);
 

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetdecoder.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetdecoder.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetdecoder.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetdecoder.h Tue Feb 19 20:21:39 2008
@@ -56,7 +56,7 @@
                   static CharsetDecoderPtr getDefaultDecoder();
               /**
                *  Get decoder for specified character set.
-               *  @param charset, the following values should be recognized:
+               *  @param charset the following values should be recognized:
                *     "US-ASCII", "ISO-8859-1", "UTF-8",
                *     "UTF-16BE", "UTF-16LE".
                *  @return decoder

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetencoder.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetencoder.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetencoder.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/charsetencoder.h Tue Feb 19 20:21:39 2008
@@ -59,7 +59,7 @@
 
               /**
                *  Get encoder for specified character set.
-               *  @param charset, the following values should be recognized:
+               *  @param charset the following values should be recognized:
                *     "US-ASCII", "ISO-8859-1", "UTF-8",
                *     "UTF-16BE", "UTF-16LE".
                *  @return encoder.

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/condition.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/condition.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/condition.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/condition.h Tue Feb 19 20:21:39 2008
@@ -33,7 +33,7 @@
 
                 /**
                  *   This class provides a means for one thread to suspend exception until
-                 *   notified by another thread to result.  This class should have 
+                 *   notified by another thread to resume.  This class should have 
                  *   similar semantics to java.util.concurrent.locks.Condition.
                  */
                 class LOG4CXX_EXPORT Condition

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/dateformat.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/dateformat.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/dateformat.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/dateformat.h Tue Feb 19 20:21:39 2008
@@ -45,10 +45,10 @@
                    /**
                    * Formats an log4cxx_time_t into a date/time string.
                    * @param s string to which the date/time string is appended.
-                   * @param date date to be formatted.
+                   * @param tm date to be formatted.
                    * @param p memory pool used during formatting.
                    */
-                   virtual void format(LogString &s, log4cxx_time_t date, log4cxx::helpers::Pool& p) const = 0;
+                   virtual void format(LogString &s, log4cxx_time_t tm, log4cxx::helpers::Pool& p) const = 0;
 
                    /**
                    * Sets the time zone.

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/datetimedateformat.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/datetimedateformat.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/datetimedateformat.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/datetimedateformat.h Tue Feb 19 20:21:39 2008
@@ -25,7 +25,7 @@
         namespace helpers
         {
                 /**
-                Formats a date in the format <b>\dd MMM yyyy HH:mm:ss,SSS</b> for example,
+                Formats a date in the format <b>dd MMM yyyy HH:mm:ss,SSS</b> for example,
            "06 Nov 1994 15:49:37,459".
                 */
                 class LOG4CXX_EXPORT DateTimeDateFormat : public SimpleDateFormat

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/fileinputstream.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/fileinputstream.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/fileinputstream.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/fileinputstream.h Tue Feb 19 20:21:39 2008
@@ -73,7 +73,7 @@
                   /**
                    * Reads a sequence of bytes into the given buffer.
                    *
-                   * @param dst The buffer into which bytes are to be transferred.
+                   * @param buf The buffer into which bytes are to be transferred.
                    * @return the total number of bytes read into the buffer, or -1 if there
                    *         is no more data because the end of the stream has been reached.
                    */

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/properties.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/properties.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/properties.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/properties.h Tue Feb 19 20:21:39 2008
@@ -59,7 +59,7 @@
 
                         <p>Every property occupies one line of the input stream.
                         Each line is terminated by a line terminator (<code>\\n</code> or
-                        <code>\r</code> or <code>\r\\n</code>).
+                        <code>\\r</code> or <code>\\r\\n</code>).
                         Lines from the input stream are processed until end of file is reached
                         on the input stream.
 
@@ -81,10 +81,10 @@
                         <code>:</code>, then it is ignored
                         and any whitespace characters after it are also skipped. All remaining
                         characters on the line become part of the associated element string.
-                        Within the element string, the ASCII escape sequences <code>\t</code>,
-                        <code>\\n</code>, <code>\r</code>, <code>\\</code>, <code>\"</code>,
-                        <code>\'</code>, <code>\\</code> (a backslash and a space), and
-                        <code>\uxxxx</code> are recognized
+                        Within the element string, the ASCII escape sequences <code>\\t</code>,
+                        <code>\\n</code>, <code>\\r</code>, <code>\\</code>, <code>\\"</code>,
+                        <code>\\'</code>, <code>\\</code> (a backslash and a space), and
+                        <code>\\uxxxx</code> are recognized
                         and converted to single characters. Moreover, if the last character on
                         the line is <code>\\</code>, then the next line is treated as a
                         continuation of the

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/simpledateformat.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/simpledateformat.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/simpledateformat.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/simpledateformat.h Tue Feb 19 20:21:39 2008
@@ -57,7 +57,7 @@
                   ~SimpleDateFormat();
 
                   virtual void format(LogString& s,
-                                      log4cxx_time_t time,
+                                      log4cxx_time_t tm,
                                       log4cxx::helpers::Pool& p) const;
 
                   /**

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/strftimedateformat.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/strftimedateformat.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/strftimedateformat.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/strftimedateformat.h Tue Feb 19 20:21:39 2008
@@ -43,7 +43,7 @@
                   ~StrftimeDateFormat();
 
                   virtual void format(LogString& s,
-                                      log4cxx_time_t time,
+                                      log4cxx_time_t tm,
                                       log4cxx::helpers::Pool& p) const;
 
                   /**

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/hierarchy.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/hierarchy.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/hierarchy.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/hierarchy.h Tue Feb 19 20:21:39 2008
@@ -195,7 +195,7 @@
             default.  This removes all appenders from all categories, sets
             the level of all non-root categories to <code>null</code>,
             sets their additivity flag to <code>true</code> and sets the level
-            of the root logger to {@link Level#DEBUG DEBUG}.  Moreover,
+            of the root logger to DEBUG.  Moreover,
             message disabling is set its default "off" value.
 
             <p>Existing categories are not removed. They are just reset.

Modified: logging/log4cxx/trunk/src/main/include/log4cxx/level.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/level.h?rev=629346&r1=629345&r2=629346&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/level.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/level.h Tue Feb 19 20:21:39 2008
@@ -73,40 +73,113 @@
                 /**
                 Convert the string passed as argument to a level. If the
                 conversion fails, then this method returns #DEBUG.
+                * @param sArg level name.
                 */
                 static LevelPtr toLevel(const std::string& sArg);
                 /**
                 Convert the string passed as argument to a level. If the
                 conversion fails, then this method returns the value of
                 <code>defaultLevel</code>.
+                * @param sArg level name.
+                * @param defaultLevel level to return if no match.
+                * @return 
                 */
                 static LevelPtr toLevel(const std::string& sArg,
                         const LevelPtr& defaultLevel);
+                /**
+                 *  Get the name of the level in the current encoding.
+                 *  @param name buffer to which name is appended.
+                 */
                 void toString(std::string& name) const;
 
 #if LOG4CXX_WCHAR_T_API
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns #DEBUG.
+                * @param sArg level name.
+                */
                 static LevelPtr toLevel(const std::wstring& sArg);
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns the value of
+                <code>defaultLevel</code>.
+                * @param sArg level name.
+                * @param defaultLevel level to return if no match.
+                * @return 
+                */
                 static LevelPtr toLevel(const std::wstring& sArg,
                         const LevelPtr& defaultLevel);
+                /**
+                 *  Get the name of the level.
+                 *  @param name buffer to which name is appended.
+                 */
                 void toString(std::wstring& name) const;
 #endif
 #if LOG4CXX_UNICHAR_API
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns #DEBUG.
+                * @param sArg level name.
+                */
                 static LevelPtr toLevel(const std::basic_string<UniChar>& sArg);
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns the value of
+                <code>defaultLevel</code>.
+                * @param sArg level name.
+                * @param defaultLevel level to return if no match.
+                * @return 
+                */
                 static LevelPtr toLevel(const std::basic_string<UniChar>& sArg,
                         const LevelPtr& defaultLevel);
+                /**
+                 *  Get the name of the level.
+                 *  @param name buffer to which name is appended.
+                 */
                 void toString(std::basic_string<UniChar>& name) const;
 #endif
 #if LOG4CXX_CFSTRING_API
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns #DEBUG.
+                * @param sArg level name.
+                */
                 static LevelPtr toLevel(const CFStringRef& sArg);
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns the value of
+                <code>defaultLevel</code>.
+                * @param sArg level name.
+                * @param defaultLevel level to return if no match.
+                * @return 
+                */
                 static LevelPtr toLevel(const CFStringRef& sArg,
                         const LevelPtr& defaultLevel);
+                /**
+                 *  Get the name of the level.
+                 *  @param name buffer to which name is appended.
+                 */
                 void toString(CFStringRef& name) const;
 #endif
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns #DEBUG.
+                * @param sArg level name.
+                */
                 static LevelPtr toLevelLS(const LogString& sArg);
+                /**
+                Convert the string passed as argument to a level. If the
+                conversion fails, then this method returns the value of
+                <code>defaultLevel</code>.
+                * @param sArg level name.
+                * @param defaultLevel level to return if no match.
+                * @return 
+                */
                 static LevelPtr toLevelLS(const LogString& sArg,
                         const LevelPtr& defaultLevel);
                 /**
-                Returns the string representation of this priority.
+                Returns the string representation of this level.
+                * @return level name.
                 */
                 LogString toString() const;