author | Mike Sullivan <Mike.Sullivan@Oracle.COM> |
Mon, 11 Mar 2013 10:38:09 -0700 | |
branch | s11-update |
changeset 2520 | ceec631e74d1 |
parent 203 | 887f23af6934 |
permissions | -rw-r--r-- |
203
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
1 |
Fix apr_hash_first() doxygen syntax. |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
2 |
http://svn.apache.org/viewvc?view=revision&revision=829490 |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
3 |
|
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
4 |
Doxgen would generate html file with full Userland build path in name |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
5 |
for this header. |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
6 |
|
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
7 |
--- include/apr_hash.h 2009/10/25 03:52:40 829489 |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
8 |
+++ include/apr_hash.h 2009/10/25 04:12:21 829490 |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
9 |
@@ -122,16 +122,15 @@ |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
10 |
* @param p The pool to allocate the apr_hash_index_t iterator. If this |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
11 |
* pool is NULL, then an internal, non-thread-safe iterator is used. |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
12 |
* @param ht The hash table |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
13 |
+ * @return The iteration state |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
14 |
* @remark There is no restriction on adding or deleting hash entries during |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
15 |
* an iteration (although the results may be unpredictable unless all you do |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
16 |
* is delete the current entry) and multiple iterations can be in |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
17 |
* progress at the same time. |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
18 |
- */ |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
19 |
-/** |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
20 |
- * @example |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
21 |
* |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
22 |
- * <PRE> |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
23 |
- * |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
24 |
+ * @par Example: |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
25 |
+ * |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
26 |
+ * @code |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
27 |
* int sum_values(apr_pool_t *p, apr_hash_t *ht) |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
28 |
* { |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
29 |
* apr_hash_index_t *hi; |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
30 |
@@ -143,7 +142,7 @@ |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
31 |
* } |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
32 |
* return sum; |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
33 |
* } |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
34 |
- * </PRE> |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
35 |
+ * @endcode |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
36 |
*/ |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
37 |
APR_DECLARE(apr_hash_index_t *) apr_hash_first(apr_pool_t *p, apr_hash_t *ht); |
887f23af6934
7035055 move apr and apr-util to userland
Petr Sumbera <petr.sumbera@oracle.com>
parents:
diff
changeset
|
38 |