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 19:54:04 UTC
svn commit: r629572 - in /logging/log4cxx/trunk/src/main/include/log4cxx: ./
filter/ helpers/ net/ pattern/ rolling/ spi/ xml/
Author: carnold
Date: Wed Feb 20 10:53:56 2008
New Revision: 629572
URL: http://svn.apache.org/viewvc?rev=629572&view=rev
Log:
LOGCXX-62: More doxygen related changes
Modified:
logging/log4cxx/trunk/src/main/include/log4cxx/consoleappender.h
logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h
logging/log4cxx/trunk/src/main/include/log4cxx/filter/stringmatchfilter.h
logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cyclicbuffer.h
logging/log4cxx/trunk/src/main/include/log4cxx/helpers/optionconverter.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/sockethubappender.h
logging/log4cxx/trunk/src/main/include/log4cxx/net/xmlsocketappender.h
logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternparser.h
logging/log4cxx/trunk/src/main/include/log4cxx/propertyconfigurator.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/timebasedrollingpolicy.h
logging/log4cxx/trunk/src/main/include/log4cxx/spi/loggingevent.h
logging/log4cxx/trunk/src/main/include/log4cxx/spi/repositoryselector.h
logging/log4cxx/trunk/src/main/include/log4cxx/xml/domconfigurator.h
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/consoleappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/consoleappender.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/consoleappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/consoleappender.h Wed Feb 20 10:53:56 2008
@@ -47,14 +47,14 @@
/**
- * Sets the value of the <b>#target</b> property. Recognized values
+ * Sets the value of the <b>target</b> property. Recognized values
* are "System.out" and "System.err". Any other value will be
* ignored.
* */
void setTarget(const LogString& value);
/**
- * Returns the current value of the <b>#target</b> property. The
+ * Returns the current value of the <b>target</b> property. The
* default value of the option is "System.out".
*
* See also #setTarget.
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=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/dailyrollingfileappender.h Wed Feb 20 10:53:56 2008
@@ -41,7 +41,7 @@
/**
- DailyRollingFileAppender extends {@link FileAppender} so that the
+ DailyRollingFileAppender extends {@link log4cxx::FileAppender 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>
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/filter/stringmatchfilter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/filter/stringmatchfilter.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/filter/stringmatchfilter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/filter/stringmatchfilter.h Wed Feb 20 10:53:56 2008
@@ -31,9 +31,9 @@
<b>AcceptOnMatch</b>. If there is a match between the value of the
StringToMatch option and the message of the {@link spi::LoggingEvent
LoggingEvent}, then the #decide method returns
- {@link spi::Filter#ACCEPT ACCEPT} if the <b>AcceptOnMatch</b> option
- value is true, if it is false then {@link spi::Filter#DENY DENY} is
- returned. If there is no match, {@link spi::Filter#NEUTRAL NEUTRAL}
+ {@link log4cxx::spi::Filter#ACCEPT ACCEPT} if the <b>AcceptOnMatch</b> option
+ value is true, if it is false then {@link log4cxx::spi::Filter#DENY DENY} is
+ returned. If there is no match, {@link log4cxx::spi::Filter#NEUTRAL NEUTRAL}
is returned.
<p>See configuration files <a
@@ -80,7 +80,7 @@
{ return acceptOnMatch; }
/**
- Returns {@link spi::Filter#NEUTRAL NEUTRAL}
+ Returns {@link log4cxx::spi::Filter#NEUTRAL NEUTRAL}
is there is no string match.
*/
FilterDecision decide(const spi::LoggingEventPtr& event) const;
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cyclicbuffer.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cyclicbuffer.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cyclicbuffer.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/cyclicbuffer.h Wed Feb 20 10:53:56 2008
@@ -25,8 +25,9 @@
namespace helpers
{
/**
- CyclicBuffer is used by other appenders to hold {@link spi::LoggingEvent
- LoggingEvents} for immediate or differed display.
+ CyclicBuffer is used by other appenders to hold instances of
+ {@link log4cxx::spi::LoggingEvent LoggingEvent} for immediate
+ or deferred display.
<p>This buffer gives read access to any element in the buffer not
just the first or last element.
*/
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/helpers/optionconverter.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/helpers/optionconverter.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/helpers/optionconverter.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/helpers/optionconverter.h Wed Feb 20 10:53:56 2008
@@ -110,6 +110,7 @@
static LogString substVars(const LogString& val, Properties& props);
/**
+ * Gets the specified system property.
@param key The key to search for.
@param def The default value to return.
@return the string value of the system property, or the default
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=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/level.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/level.h Wed Feb 20 10:53:56 2008
@@ -72,7 +72,7 @@
/**
Convert the string passed as argument to a level. If the
- conversion fails, then this method returns #DEBUG.
+ conversion fails, then this method returns DEBUG.
* @param sArg level name.
*/
static LevelPtr toLevel(const std::string& sArg);
@@ -95,7 +95,7 @@
#if LOG4CXX_WCHAR_T_API
/**
Convert the string passed as argument to a level. If the
- conversion fails, then this method returns #DEBUG.
+ conversion fails, then this method returns DEBUG.
* @param sArg level name.
*/
static LevelPtr toLevel(const std::wstring& sArg);
@@ -118,7 +118,7 @@
#if LOG4CXX_UNICHAR_API
/**
Convert the string passed as argument to a level. If the
- conversion fails, then this method returns #DEBUG.
+ conversion fails, then this method returns DEBUG.
* @param sArg level name.
*/
static LevelPtr toLevel(const std::basic_string<UniChar>& sArg);
@@ -141,7 +141,7 @@
#if LOG4CXX_CFSTRING_API
/**
Convert the string passed as argument to a level. If the
- conversion fails, then this method returns #DEBUG.
+ conversion fails, then this method returns DEBUG.
* @param sArg level name.
*/
static LevelPtr toLevel(const CFStringRef& sArg);
@@ -163,7 +163,7 @@
#endif
/**
Convert the string passed as argument to a level. If the
- conversion fails, then this method returns #DEBUG.
+ conversion fails, then this method returns DEBUG.
* @param sArg level name.
*/
static LevelPtr toLevelLS(const LogString& sArg);
@@ -185,7 +185,7 @@
/**
Convert an integer passed as argument to a level. If the
- conversion fails, then this method returns #DEBUG.
+ conversion fails, then this method returns DEBUG.
*/
static LevelPtr toLevel(int val);
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/logger.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/logger.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/logger.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/logger.h Wed Feb 20 10:53:56 2008
@@ -1035,7 +1035,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param values The values for the placeholders <code>{0}</code>,
<code>{1}</code> etc. within the pattern.
@@ -1054,7 +1054,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@see #setResourceBundle
@@ -1070,7 +1070,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The first value for the placeholders within the pattern.
@@ -1088,7 +1088,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The first value for the placeholders within the pattern.
@param val2 The second value for the placeholders within the pattern.
@@ -1107,7 +1107,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1129,7 +1129,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@see #setResourceBundle
@@ -1145,7 +1145,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@@ -1163,7 +1163,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1182,7 +1182,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1204,7 +1204,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@see #setResourceBundle
@@ -1220,7 +1220,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@@ -1238,7 +1238,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1257,7 +1257,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1280,7 +1280,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@see #setResourceBundle
@@ -1296,7 +1296,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@@ -1314,7 +1314,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1333,7 +1333,7 @@
supplied string array <code>params</code>.
@param level The level of the logging request.
- @param key The key to be searched in the #ResourceBundle.
+ @param key The key to be searched in the ResourceBundle.
@param locationInfo The location info of the logging request.
@param val1 The value for the first placeholder within the pattern.
@param val2 The value for the second placeholder within the pattern.
@@ -1472,7 +1472,7 @@
virtual void setLevel(const LevelPtr& level);
/**
- Set the resource bundle to be used with localized logging method #l7dlog.
+ Set the resource bundle to be used with localized logging methods.
*/
inline void setResourceBundle(const helpers::ResourceBundlePtr& bundle)
{ resourceBundle = bundle; }
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/logmanager.h Wed Feb 20 10:53:56 2008
@@ -35,8 +35,9 @@
/**
* Use the <code>LogManager</code> class to retreive Logger
- * instances or to operate on the current {@link spi::LoggerRepository
- * LoggerRepository}. When the <code>LogManager</code> class is loaded
+ * instances or to operate on the current
+ * {@link log4cxx::spi::LoggerRepository LoggerRepository}.
+ * When the <code>LogManager</code> class is loaded
* into memory the default initialization procedure is inititated.
*/
class LOG4CXX_EXPORT LogManager
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/mdc.h Wed Feb 20 10:53:56 2008
@@ -30,7 +30,7 @@
namespace log4cxx
{
/**
- The MDC class is similar to the {@link NDC} class except that it is
+ The MDC class is similar to the {@link log4cxx::NDC NDC} class except that it is
based on a map instead of a stack. It provides <em>mapped
diagnostic contexts</em>. A <em>Mapped Diagnostic Context</em>, or
MDC in short, is an instrument for distinguishing interleaved log
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/ndc.h Wed Feb 20 10:53:56 2008
@@ -90,11 +90,6 @@
and sometimes forget to call #remove before exiting a
thread.
- <p>a thread may inherit the nested diagnostic context of another
- (possibly parent) thread using the #inherit
- method. a thread may obtain a copy of its ndc with the
- #clonestack method and pass the reference to any other
- thread, in particular to a child.
*/
class LOG4CXX_EXPORT NDC
{
@@ -130,16 +125,13 @@
Clear any nested diagnostic information if any. This method is
useful in cases where the same thread can be potentially used
over and over in different unrelated contexts.
- <p>This method is equivalent to calling the #setMaxDepth
- method with a zero <code>maxDepth</code> argument.
*/
static void clear();
/**
- <b>Never use this method directly, use the
- {@link spi::LoggingEvent#getNDC LoggingEvent::getNDC}
- method instead.</b>
+ * Get the current value of the NDC of the
+ * currrent thread.
* @param dest destination to which to append content of NDC.
* @return true if NDC is set.
*/
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/net/socketappender.h Wed Feb 20 10:53:56 2008
@@ -27,7 +27,7 @@
{
/**
- Sends {@link spi::LoggingEvent LoggingEvent} objects to a remote a log server,
+ Sends {@link log4cxx::spi::LoggingEvent LoggingEvent} objects to a remote a log server,
usually Apache Chainsaw.
<p>The SocketAppender has the following properties:
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/net/sockethubappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/net/sockethubappender.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/net/sockethubappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/net/sockethubappender.h Wed Feb 20 10:53:56 2008
@@ -39,7 +39,7 @@
namespace net
{
/**
- Sends {@link spi::LoggingEvent LoggingEvent} objects to a set of remote log
+ Sends {@link log4cxx::spi::LoggingEvent LoggingEvent} objects to a set of remote log
servers, usually a SocketNode.
<p>Acts just like SocketAppender except that instead of
@@ -141,11 +141,6 @@
*/
virtual void setOption(const LogString& option, const LogString& value);
- /**
- Close this appender.
- <p>This will mark the appender as closed and
- call then #cleanUp method.
- */
virtual void close();
/**
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/net/xmlsocketappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/net/xmlsocketappender.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/net/xmlsocketappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/net/xmlsocketappender.h Wed Feb 20 10:53:56 2008
@@ -27,7 +27,7 @@
{
/**
- Sends {@link spi::LoggingEvent LoggingEvent} objects in XML format
+ Sends {@link log4cxx::spi::LoggingEvent LoggingEvent} objects in XML format
to a remote a log server, usually a XMLSocketNode.
<p>The XMLSocketAppender has the following properties:
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternparser.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternparser.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternparser.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/pattern/patternparser.h Wed Feb 20 10:53:56 2008
@@ -44,16 +44,10 @@
// Reinhard Deschler <re...@web.de>
/**
- * Most of the work of the {@link PatternLayout} class
+ * Most of the work of the {@link log4cxx::PatternLayout PatternLayout} class
* is delegated to the PatternParser class.
* <p>It is this class that parses conversion patterns and creates
* a chained list of {@link PatternConverter PatternConverters}.
- *
- *
- *
- *
- *
- *
*
*
*/
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/propertyconfigurator.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/propertyconfigurator.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/propertyconfigurator.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/propertyconfigurator.h Wed Feb 20 10:53:56 2008
@@ -52,7 +52,7 @@
/**
Allows the configuration of log4cxx from an external file. See
-<b>{@link #doConfigure(const File&, spi::LoggerRepositoryPtr&)}</b>
+<b>{@link #doConfigure(const File&, log4cxx::spi::LoggerRepositoryPtr&)}</b>
for the expected format.
<p>It is sometimes useful to see how log4cxx is reading configuration
@@ -324,14 +324,14 @@
/**
Read configuration options from <code>properties</code>.
- See #doConfigure(const string&, spi::LoggerRepositoryPtr&)
+ See #doConfigure(const File&, log4cxx::spi::LoggerRepositoryPtr&)
for the expected format.
*/
static void configure(helpers::Properties& properties);
/**
Read configuration options from <code>properties</code>.
- See #doConfigure(const String&, spi::LoggerRepositoryPtr&)
+ See #doConfigure(const File&, log4cxx::spi::LoggerRepositoryPtr&)
for the expected format.
*/
void doConfigure(helpers::Properties& properties,
@@ -344,7 +344,7 @@
/**
Check the provided <code>Properties</code> object for a
#loggerFactory
- entry specified by #LOGGER_FACTORY_KEY. If such an entry
+ entry specified by LOGGER_FACTORY_KEY. If such an entry
exists, an attempt is made to create an instance using the default
constructor. This instance is used for subsequent Logger creations
within this configurator.
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h Wed Feb 20 10:53:56 2008
@@ -102,10 +102,10 @@
/**
-* Initialize the policy and return any initial actions for rolling file appender..
+* Initialize the policy and return any initial actions for rolling file appender.
*
-* @param file current value of RollingFileAppender.getFile().
-* @param append current value of RollingFileAppender.getAppend().
+* @param file current value of RollingFileAppender::getFile().
+* @param append current value of RollingFileAppender::getAppend().
* @param p pool used for any required memory allocations.
* @return Description of the initialization, may be null to indicate
* no initialization needed.
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingfileappender.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingfileappender.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingfileappender.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingfileappender.h Wed Feb 20 10:53:56 2008
@@ -26,14 +26,14 @@
/**
- * <code>RollingFileAppender</code> extends {@link FileAppender} to backup the log files
- * depending on {@link RollingPolicy} and {@link TriggeringPolicy}.
+ * <code>RollingFileAppender</code> extends {@link log4cxx::FileAppender} to backup the log files
+ * depending on {@link log4cxx::rolling::RollingPolicy RollingPolicy} and {@link log4cxx::rolling::TriggeringPolicy TriggeringPolicy}.
* <p>
* To be of any use, a <code>RollingFileAppender</code> instance must have both
* a <code>RollingPolicy</code> and a <code>TriggeringPolicy</code> set up.
* However, if its <code>RollingPolicy</code> also implements the
* <code>TriggeringPolicy</code> interface, then only the former needs to be
- * set up. For example, {@link TimeBasedRollingPolicy} acts both as a
+ * set up. For example, {@link log4cxx::rolling::TimeBasedRollingPolicy TimeBasedRollingPolicy} acts both as a
* <code>RollingPolicy</code> and a <code>TriggeringPolicy</code>.
*
* <p><code>RollingFileAppender</code> can be configured programattically or
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingpolicy.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingpolicy.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingpolicy.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/rolling/rollingpolicy.h Wed Feb 20 10:53:56 2008
@@ -44,7 +44,7 @@
public:
virtual ~RollingPolicy() {}
/**
- * Initialize the policy and return any initial actions for rolling file appender..
+ * Initialize the policy and return any initial actions for rolling file appender.
*
* @param file current value of RollingFileAppender.getFile().
* @param append current value of RollingFileAppender.getAppend().
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/rolling/timebasedrollingpolicy.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/rolling/timebasedrollingpolicy.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/rolling/timebasedrollingpolicy.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/rolling/timebasedrollingpolicy.h Wed Feb 20 10:53:56 2008
@@ -167,7 +167,7 @@
void releaseRef() const;
void activateOptions(log4cxx::helpers::Pool& );
/**
- * Initialize the policy and return any initial actions for rolling file appender..
+ * Initialize the policy and return any initial actions for rolling file appender.
*
* @param file current value of RollingFileAppender.getFile().
* @param append current value of RollingFileAppender.getAppend().
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/spi/loggingevent.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/spi/loggingevent.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/spi/loggingevent.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/spi/loggingevent.h Wed Feb 20 10:53:56 2008
@@ -68,7 +68,7 @@
/**
Instantiate a LoggingEvent from the supplied parameters.
- <p>Except #timeStamp all the other fields of
+ <p>Except timeStamp all the other fields of
<code>LoggingEvent</code> are filled when actually needed.
<p>
@param logger The logger of this event.
@@ -82,20 +82,20 @@
~LoggingEvent();
- /** Return the #level of this event. */
+ /** Return the level of this event. */
inline const LevelPtr& getLevel() const
{ return level; }
- /** Return the name of the #logger. */
+ /** Return the name of the logger. */
inline const LogString& getLoggerName() const {
return logger;
}
- /** Return the #message for this logging event. */
+ /** Return the message for this logging event. */
inline const LogString& getMessage() const
{ return message; }
- /** Return the #message for this logging event. */
+ /** Return the message for this logging event. */
inline const LogString& getRenderedMessage() const
{ return message; }
@@ -104,12 +104,12 @@
*/
static log4cxx_time_t getStartTime();
- /** Return the #threadName of this event. */
+ /** Return the threadName of this event. */
inline const LogString& getThreadName() const {
return threadName;
}
- /** Return the #timeStamp of this event. */
+ /** Return the timeStamp of this event. */
inline log4cxx_time_t getTimeStamp() const
{ return timeStamp; }
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/spi/repositoryselector.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/spi/repositoryselector.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/spi/repositoryselector.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/spi/repositoryselector.h Wed Feb 20 10:53:56 2008
@@ -31,7 +31,7 @@
/**
The <code>LogManager</code> uses one (and only one)
<code>RepositorySelector</code> implementation to select the
- {@link LoggerRepository LoggerRepository}
+ {@link log4cxx::spi::LoggerRepository LoggerRepository}
for a particular application context.
<p>It is the responsability of the <code>RepositorySelector</code>
Modified: logging/log4cxx/trunk/src/main/include/log4cxx/xml/domconfigurator.h
URL: http://svn.apache.org/viewvc/logging/log4cxx/trunk/src/main/include/log4cxx/xml/domconfigurator.h?rev=629572&r1=629571&r2=629572&view=diff
==============================================================================
--- logging/log4cxx/trunk/src/main/include/log4cxx/xml/domconfigurator.h (original)
+++ logging/log4cxx/trunk/src/main/include/log4cxx/xml/domconfigurator.h Wed Feb 20 10:53:56 2008
@@ -235,9 +235,9 @@
static void configure(const CFStringRef& filename);
#endif
/**
- Like #configureAndWatch(const String& configFilename, long delay)
+ Like #configureAndWatch(const std::string& configFilename, long delay)
except that the default delay as defined by
- helpers::FileWatchdog#DEFAULT_DELAY is used.
+ log4cxx::helpers::FileWatchdog#DEFAULT_DELAY is used.
@param configFilename A log4j configuration file in XML format.
*/
static void configureAndWatch(const std::string& configFilename);