svn commit: r829490 - /apr/apr/trunk/include/apr_hash.h

[bo...@apache.org]

Author: bojan
Date: Sun Oct 25 04:12:21 2009
New Revision: 829490

URL: http://svn.apache.org/viewvc?rev=829490&view=rev
Log:
Fix apr_hash_first() doxygen syntax.

Modified:
    apr/apr/trunk/include/apr_hash.h

Modified: apr/apr/trunk/include/apr_hash.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_hash.h?rev=829490&r1=829489&r2=829490&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_hash.h (original)
+++ apr/apr/trunk/include/apr_hash.h Sun Oct 25 04:12:21 2009
@@ -122,16 +122,15 @@
  * @param p The pool to allocate the apr_hash_index_t iterator. If this
  *          pool is NULL, then an internal, non-thread-safe iterator is used.
  * @param ht The hash table
+ * @return The iteration state
  * @remark  There is no restriction on adding or deleting hash entries during
  * an iteration (although the results may be unpredictable unless all you do
  * is delete the current entry) and multiple iterations can be in
  * progress at the same time.
- */
-/**
- * @example
  *
- * <PRE>
- * 
+ * @par Example:
+ *
+ * @code
  * int sum_values(apr_pool_t *p, apr_hash_t *ht)
  * {
  *     apr_hash_index_t *hi;
@@ -143,7 +142,7 @@
  *     }
  *     return sum;
  * }
- * </PRE>
+ * @endcode
  */
 APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_pool_t *p, apr_hash_t *ht);