activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject svn commit: r924496 - in /activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util: concurrent/BlockingQueue.h concurrent/RejectedExecutionHandler.h logging/LogManager.h logging/StreamHandler.h logging/XMLFormatter.h zip/Deflater.h zip/Inflater.h
Date Wed, 17 Mar 2010 21:17:08 GMT
Author: tabish
Date: Wed Mar 17 21:16:53 2010
New Revision: 924496

URL: http://svn.apache.org/viewvc?rev=924496&view=rev
Log:
Cleanup the API docs to fix Doxygen warnings (decaf::util) package

Modified:
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/BlockingQueue.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/RejectedExecutionHandler.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/LogManager.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/StreamHandler.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/XMLFormatter.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Deflater.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Inflater.h

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/BlockingQueue.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/BlockingQueue.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/BlockingQueue.h
(original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/BlockingQueue.h
Wed Mar 17 21:16:53 2010
@@ -29,11 +29,11 @@ namespace util {
 namespace concurrent {
 
     /**
-     * A {@link java.util.Queue} that additionally supports operations that wait for
+     * A decaf::util::Queue that additionally supports operations that wait for
      * the queue to become non-empty when retrieving an element, and wait for space
      * to become available in the queue when storing an element.
      *
-     * <p><tt>BlockingQueue</tt> methods come in four forms, with different
ways of
+     * <tt>BlockingQueue</tt> methods come in four forms, with different ways
of
      * handling operations that cannot be satisfied immediately, but may be satisfied
      * at some point in the future:
      * one throws an exception, the second returns a special value (either
@@ -42,7 +42,6 @@ namespace concurrent {
      * and the fourth blocks for only a given maximum time limit before giving
      * up.  These methods are summarized in the following table:
      *
-     * <p>
      * <table BORDER CELLPADDING=3 CELLSPACING=1>
      *  <tr>
      *    <td></td>
@@ -74,19 +73,19 @@ namespace concurrent {
      *  </tr>
      * </table>
      *
-     * <p>A <tt>BlockingQueue</tt> may be capacity bounded. At any given
time it may have
+     * A <tt>BlockingQueue</tt> may be capacity bounded. At any given time it
may have
      * a <tt>remainingCapacity</tt> beyond which no additional elements can be
<tt>put</tt>
      * without blocking.  A <tt>BlockingQueue</tt> without any intrinsic capacity
      * constraints always reports a remaining capacity of <tt>Integer::MAX_VALUE</tt>.
      *
-     * <p> <tt>BlockingQueue</tt> implementations are designed to be used
primarily for
-     * producer-consumer queues, but additionally support {@link decaf.util.Collection}
+     * <tt>BlockingQueue</tt> implementations are designed to be used primarily
for
+     * producer-consumer queues, but additionally support {@link decaf::util::Collection}
      * interface.  So, for example, it is possible to remove an arbitrary element from a
      * queue using <tt>remove(x)</tt>. However, such operations are in general
<em>not</em>
      * performed very efficiently, and are intended for only occasional use, such as
      * when a queued message is cancelled.
      *
-     * <p> <tt>BlockingQueue</tt> implementations are thread-safe.  All
queuing methods
+     * <tt>BlockingQueue</tt> implementations are thread-safe.  All queuing methods
      * achieve their effects atomically using internal locks or other forms of concurrency
      * control. However, the <em>bulk</em> Collection operations <tt>addAll</tt>,
      * <tt>containsAll</tt>, <tt>retainAll</tt> and <tt>removeAll</tt>
are <em>not</em>
@@ -94,7 +93,7 @@ namespace concurrent {
      * So it is possible, for example, for <tt>addAll(c)</tt> to fail (throwing
an exception)
      * after adding only some of the elements in <tt>c</tt>.
      *
-     * <p>A <tt>BlockingQueue</tt> does <em>not</em> intrinsically
support any kind of
+     * A <tt>BlockingQueue</tt> does <em>not</em> intrinsically support
any kind of
      * &quot;close&quot; or &quot;shutdown&quot; operation to indicate that
no more
      * items will be added.  The needs and usage of such features tend to be
      * implementation-dependent. For example, a common tactic is for producers to
@@ -155,9 +154,9 @@ namespace concurrent {
      * </pre>
      *
      * <p>Memory consistency effects: As with other concurrent collections, actions
in a
-     * thread prior to placing an object into a {@code BlockingQueue} <em>happen-before</em><
+     * thread prior to placing an object into a BlockingQueue <em>happen-before</em>
      * actions subsequent to the access or removal of that element from the
-     * {@code BlockingQueue} in another thread.
+     * BlockingQueue in another thread.
      *
      * @since 1.0
      */

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/RejectedExecutionHandler.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/RejectedExecutionHandler.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/RejectedExecutionHandler.h
(original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/RejectedExecutionHandler.h
Wed Mar 17 21:16:53 2010
@@ -47,12 +47,14 @@ namespace concurrent {
          *
          * <p>In the absence of other alternatives, the method may throw
          * an {@link RejectedExecutionException}, which will be propagated to
-         * the caller of {@code execute}.
+         * the caller of {@link ThreadPoolExecutor#execute execute}.
          *
-         * @param r pointer to the runnable task requested to be executed
-         * @param executor pointer to the executor attempting to execute this task
+         * @param r
+         *      The pointer to the runnable task requested to be executed.
+         * @param executor
+         *      The pointer to the executor attempting to execute this task.
          *
-         * @throws RejectedExecutionException if there is no remedy
+         * @throws RejectedExecutionException if there is no remedy.
          */
         virtual void rejectedExecution( Runnable* r, ThreadPoolExecutor* executer )
             throw( RejectedExecutionException ) = 0;

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/LogManager.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/LogManager.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/LogManager.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/LogManager.h Wed
Mar 17 21:16:53 2010
@@ -60,7 +60,7 @@ namespace logging{
      *     objects to configure themselves.
      *
      * The global LogManager object can be retrieved using
-     * LogManager.getLogManager(). The LogManager object is created during
+     * LogManager::getLogManager(). The LogManager object is created during
      * class initialization and cannot subsequently be changed.
      *
      * ***TODO****
@@ -87,14 +87,14 @@ namespace logging{
      * alternate configuration class can use readConfiguration(InputStream)
      * to define properties in the LogManager.
      *
-     * If "java.util.logging.config.class" property is not set, then the
-     * "java.util.logging.config.file" system property can be used to specify
-     * a properties file (in java.util.Properties format). The initial
+     * If "decaf.util.logging.config.class" property is not set, then the
+     * "decaf.util.logging.config.file" system property can be used to specify
+     * a properties file (in decaf.util.Properties format). The initial
      * logging configuration will be read from this file.
      *
      * If neither of these properties is defined then, as described above,
      * the LogManager will read its initial configuration from a properties
-     * file "lib/logging.properties" in the JRE directory.
+     * file "lib/logging.properties" in the working directory.
      *
      * The properties for loggers and Handlers will have names starting with
      * the dot-separated name for the handler or logger.
@@ -286,7 +286,7 @@ namespace logging{
     public:     // Static Singleton Methods.
 
         /**
-         * Get the global {@code LogManager} instance.
+         * Get the global LogManager instance.
          * @return A reference to the global LogManager instance.
          */
         static LogManager& getLogManager();

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/StreamHandler.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/StreamHandler.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/StreamHandler.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/StreamHandler.h Wed
Mar 17 21:16:53 2010
@@ -38,7 +38,7 @@ namespace logging{
      * This is primarily intended as a base class or support class to be used in implementing
      * other logging Handlers.
      *
-     * LogRecords are published to a given <code>decaf.io.OutputStream</code>.
+     * LogRecords are published to a given <code>decaf::io::OutputStream</code>.
      *
      * Configuration: By default each StreamHandler is initialized using the following LogManager
      * configuration properties. If properties are not defined (or have invalid values) then
the
@@ -81,13 +81,13 @@ namespace logging{
 
         /**
          * Close the current output stream.
-         * <p>
+         *
          * The close method will perform a flush and then close the Handler.
          * After close has been called this Handler  should no longer be used.
          * Method calls may either be silently ignored or may throw runtime
          * exceptions.
          *
-         * @throw IOException
+         * @throw IOException if an I/O error occurs.
          */
         virtual void close() throw ( decaf::io::IOException );
 
@@ -123,7 +123,8 @@ namespace logging{
          * the stream is flushed and closed. Then the output stream is replaced with the
new
          * output stream.
          *
-         * @param stream - New output stream. May not be NULL.
+         * @param stream
+         *      The new output stream. May not be NULL.
          *
          * @throws NullPointerException if the passed stream is NULL.
          */
@@ -132,10 +133,10 @@ namespace logging{
 
         /**
          * Closes this handler, but the underlying output stream is only closed if
-         * {@code closeStream} is {@code true}.
+         * closeStream is true.
          *
          * @param closeStream
-         *            whether to close the underlying output stream.
+         *      whether to close the underlying output stream.
          */
         void close( bool closeStream );
 

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/XMLFormatter.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/XMLFormatter.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/XMLFormatter.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/logging/XMLFormatter.h Wed
Mar 17 21:16:53 2010
@@ -45,7 +45,7 @@ namespace logging {
         virtual ~XMLFormatter();
 
         /**
-         * Converts a {@code LogRecord} into an XML string.
+         * Converts a LogRecord into an XML string.
          *
          * @param record
          *       The log record to be formatted.
@@ -60,7 +60,7 @@ namespace logging {
          * using the default platform encoding.
          *
          * @param handler
-         *       The output handler, may be {@code null}.
+         *       The output handler, may be NULL.
          *
          * @return the header string for log records formatted as XML strings.
          */
@@ -71,7 +71,7 @@ namespace logging {
          * strings.
          *
          * @param handler
-         *       The output handler, may be {@code null}.
+         *       The output handler, may be NULL.
          *
          * @return the tail string for log records formatted as XML strings.
          */

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Deflater.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Deflater.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Deflater.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Deflater.h Wed Mar 17
21:16:53 2010
@@ -38,12 +38,12 @@ namespace zip {
      * href="http://www.gzip.org/algorithm.txt">specification</a>).
      *
      * Basically this class is part of the API to the stream based ZLIB compression
-     * library and is used as such by {@code DeflaterOutputStream} and its
+     * library and is used as such by DeflaterOutputStream and its
      * descendants.
      *
-     * The typical usage of a {@code Deflater} instance outside this package
-     * consists of a specific call to one of its constructors before being passed to
-     * an instance of {@code DeflaterOutputStream}.
+     * The typical usage of a Deflater instance outside this package consists of a
+     * specific call to one of its constructors before being passed to an instance
+     * of DeflaterOutputStream.
      *
      * @see DeflaterOutputStream
      * @see Inflater

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Inflater.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Inflater.h?rev=924496&r1=924495&r2=924496&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Inflater.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/zip/Inflater.h Wed Mar 17
21:16:53 2010
@@ -40,12 +40,11 @@ namespace zip {
      * algorithm (see <a href="http://www.gzip.org/algorithm.txt">specification</a>).
      * <p>
      * Basically this class is part of the API to the stream based ZLIB compression
-     * library and is used as such by {@code InflaterInputStream} and its
-     * descendants.
+     * library and is used as such by InflaterInputStream and its descendants.
      * <p>
-     * The typical usage of a {@code Inflater} outside this package consists of a
-     * specific call to one of its constructors before being passed to an instance
-     * of {@code InflaterInputStream}.
+     * The typical usage of a Inflater outside this package consists of a specific
+     * call to one of its constructors before being passed to an instance of
+     * InflaterInputStream.
      *
      * @see InflaterInputStream
      * @see Deflater



Mime
View raw message