Author: julianfoad
Date: Wed Mar 26 13:24:34 2014
New Revision: 1581825
URL: http://svn.apache.org/r1581825
Log:
Fix Doxygen mark-up.
* subversion/include/svn_client.h
(svn_client_ctx_t): s/@Since/@since/.
(svn_client_cleanup): Mark the doc string as a Doxygen comment.
* subversion/include/svn_compat.h
(svn_compat_log_revprops_out): Correct a cross-reference.
* subversion/include/svn_config.h
(cached_authentication_data_attributes): Give this Doxygen group a title.
* subversion/include/svn_fs.h
(svn_fs_lock_target_t,
svn_fs_lock_result_t): Mark the doc strings as Doxygen comments.
(svn_fs_lock2): Correct a <tt> closing tag to </tt>.
(svn_fs_lock): Mark the doc string as a Doxygen comment.
(svn_fs_unlock2): Correct cross-references. s/pool/scratch_pool/.
* subversion/include/svn_mergeinfo.h
(SVN_MERGEINFO_NONINHERITABLE_STR): Mark the doc string as a Doxygen
comment.
(svn_rangelist_t, svn_mergeinfo_t, svn_mergeinfo_catalog_t): Give each of
these types its own Doxygen doc string.
* subversion/include/svn_path.h
(svn_path_illegal_path_escape): Mark the doc string as a Doxygen comment.
* subversion/include/svn_ra.h
(svn_ra_get_file_revs2): s/@handler/@a handler/g.
* subversion/include/svn_repos.h
(svn_repos_get_logs4): Correct a cross-reference.
(svn_repos_get_file_revs2): s/@handler/@a handler/g.
* subversion/include/svn_types.h
(svn_move_behavior_t): Mark each member's doc string as a Doxygen comment.
* subversion/include/svn_wc.h
(svn_wc_conflict_description3_t): Mark a member's doc string as a Doxygen
comment.
(svn_wc_conflict_description_create_text2,
svn_wc_conflict_description_create_prop2,
svn_wc_conflict_description_create_tree2): Mark the doc string as a
Doxygen comment, and use () notation for a function cross-reference.
(svn_wc_conflict_resolver_func2_t): Mark the doc string as a Doxygen
comment.
Modified:
subversion/trunk/subversion/include/svn_client.h
subversion/trunk/subversion/include/svn_compat.h
subversion/trunk/subversion/include/svn_config.h
subversion/trunk/subversion/include/svn_fs.h
subversion/trunk/subversion/include/svn_mergeinfo.h
subversion/trunk/subversion/include/svn_path.h
subversion/trunk/subversion/include/svn_ra.h
subversion/trunk/subversion/include/svn_repos.h
subversion/trunk/subversion/include/svn_types.h
subversion/trunk/subversion/include/svn_wc.h
Modified: subversion/trunk/subversion/include/svn_client.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_client.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_client.h (original)
+++ subversion/trunk/subversion/include/svn_client.h Wed Mar 26 13:24:34 2014
@@ -1016,7 +1016,7 @@ typedef struct svn_client_ctx_t
/** Total number of bytes transferred over network.
*
- * @Since New in 1.9. */
+ * @since New in 1.9. */
apr_off_t progress;
/** Check-tunnel callback
@@ -4147,7 +4147,7 @@ svn_client_cleanup2(const char *dir_absp
svn_client_ctx_t *ctx,
apr_pool_t *scratch_pool);
-/* Like svn_client_cleanup2(), but no support for not breaking locks and
+/** Like svn_client_cleanup2(), but no support for not breaking locks and
* cleaning up externals and using a potentially non absolute path.
*
* @deprecated Provided for limited backwards compatibility with the 1.8 API.
Modified: subversion/trunk/subversion/include/svn_compat.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_compat.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_compat.h (original)
+++ subversion/trunk/subversion/include/svn_compat.h Wed Mar 26 13:24:34 2014
@@ -84,7 +84,7 @@ svn_compat_log_revprops_out_string(const
const svn_string_t **message,
apr_hash_t *revprops);
-/** Simiar to #svn_compat_log_revprops_out2 but returns C-style strings
+/** Simiar to svn_compat_log_revprops_out_string() but returns C-style strings
* instead of #svn_string_t.
*
* @since New in 1.5.
Modified: subversion/trunk/subversion/include/svn_config.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_config.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_config.h (original)
+++ subversion/trunk/subversion/include/svn_config.h Wed Mar 26 13:24:34 2014
@@ -680,7 +680,7 @@ svn_config_ensure(const char *config_dir
* not part of the public API (except #SVN_CONFIG_REALMSTRING_KEY which
* has been present since 1.0).
*
- * @defgroup cached_authentication_data_attributes
+ * @defgroup cached_authentication_data_attributes Cached authentication data
attributes
* @{
*/
Modified: subversion/trunk/subversion/include/svn_fs.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Wed Mar 26 13:24:34 2014
@@ -2512,7 +2512,7 @@ svn_fs_set_uuid(svn_fs_t *fs,
* expiration error (depending on the API).
*/
-/* The @a targets hash passed to svn_fs_lock2() has <tt>const char
+/** The @a targets hash passed to svn_fs_lock2() has <tt>const char
*</tt> keys and <tt>svn_fs_lock_target_t *</tt> values. */
typedef struct svn_fs_lock_target_t
{
@@ -2521,7 +2521,7 @@ typedef struct svn_fs_lock_target_t
} svn_fs_lock_target_t;
-/* The @a results hash returned by svn_fs_lock2() and svn_fs_unlock2()
+/** The @a results hash returned by svn_fs_lock2() and svn_fs_unlock2()
has <tt>const char *</tt> keys and <tt>svn_fs_lock_result_t *</tt>
values. */
typedef struct svn_fs_lock_result_t
@@ -2549,7 +2549,7 @@ typedef struct svn_fs_lock_result_t
* generic DAV client; only mod_dav_svn's autoversioning feature needs
* to use it. If in doubt, pass 0.
*
- * The paths to be locked are passed as the <tt>const char *<tt> keys
+ * The paths to be locked are passed as the <tt>const char *</tt> keys
* of the @a targets hash. The hash values are
* <tt>svn_fs_lock_target_t *</tt> and provide the token and
* current_rev for each path. The token is a lock token such as can
@@ -2595,7 +2595,7 @@ svn_fs_lock2(apr_hash_t **results,
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
-/* Similar to svn_fs_lock2() but locks only a single @a path and
+/** Similar to svn_fs_lock2() but locks only a single @a path and
* returns the lock in @a *lock, allocated in @a pool, or an error.
*
* @since New in 1.2.
@@ -2653,11 +2653,11 @@ svn_fs_generate_lock_token(const char **
* passed (it is not possible to pass @c NULL as a hash value
* directly), #svn_fs_lock_target_t->current_rev is ignored.
*
- * @note #svn_err_fs_lock_result_t is used to allow @c SVN_NO_ERROR to
+ * @note #svn_fs_lock_result_t is used to allow @c SVN_NO_ERROR to
* be returned (it is not possible to return @c SVN_NO_ERROR as a hash
- * value directly), #svn_err_fs_lock_result_t->lock is always NULL.
+ * value directly), #svn_fs_lock_result_t->lock is always NULL.
*
- * Use @a pool for temporary allocations.
+ * Use @a scratch_pool for temporary allocations.
*
* @since New in 1.9.
*/
Modified: subversion/trunk/subversion/include/svn_mergeinfo.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_mergeinfo.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_mergeinfo.h (original)
+++ subversion/trunk/subversion/include/svn_mergeinfo.h Wed Mar 26 13:24:34 2014
@@ -102,7 +102,7 @@ extern "C" {
* both acceptable).
*/
-/* Suffix for SVN_PROP_MERGEINFO revision ranges indicating a given
+/** Suffix for SVN_PROP_MERGEINFO revision ranges indicating a given
range is non-inheritable. */
#define SVN_MERGEINFO_NONINHERITABLE_STR "*"
@@ -113,34 +113,40 @@ extern "C" {
*
* (a) Strings (@c svn_string_t *) containing "unparsed mergeinfo".
*
- * (b) @c svn_rangelist_t, called a "rangelist". An array of non-
- * overlapping merge ranges (@c svn_merge_range_t *), sorted as said by
- * @c svn_sort_compare_ranges(). An empty range list is represented by
- * an empty array. Unless specifically noted otherwise, all APIs require
- * rangelists that describe only forward ranges, i.e. the range's start
- * revision is less than its end revision.
- *
- * (c) @c svn_mergeinfo_t, called "mergeinfo". A hash mapping merge
- * source paths (@c const char *, starting with slashes) to
- * non-empty rangelist arrays. A @c NULL hash is used to represent
- * no mergeinfo and an empty hash is used to represent empty
- * mergeinfo.
+ * (b) @c svn_rangelist_t, called a "rangelist".
*
- * (d) @c svn_mergeinfo_catalog_t, called a "mergeinfo catalog". A hash
- * mapping paths (@c const char *) to @c svn_mergeinfo_t.
+ * (c) @c svn_mergeinfo_t, called "mergeinfo".
+ *
+ * (d) @c svn_mergeinfo_catalog_t, called a "mergeinfo catalog".
*
* Both @c svn_mergeinfo_t and @c svn_mergeinfo_catalog_t are just
* typedefs for @c apr_hash_t *; there is no static type-checking, and
* you still use standard @c apr_hash_t functions to interact with
* them.
- *
- * Note that while the keys of mergeinfos are always absolute from the
- * repository root, the keys of a catalog may be relative to something
- * else, such as an RA session root.
*/
+/** An array of non-overlapping merge ranges (@c svn_merge_range_t *),
+ * sorted as said by @c svn_sort_compare_ranges(). An empty range list is
+ * represented by an empty array.
+ *
+ * Unless specifically noted otherwise, all APIs require rangelists that
+ * describe only forward ranges, i.e. the range's start revision is less
+ * than its end revision. */
typedef apr_array_header_t svn_rangelist_t;
+
+/** A hash mapping merge source paths to non-empty rangelist arrays.
+ *
+ * The keys are (@c const char *) absolute paths from the repository root,
+ * starting with slashes. A @c NULL hash represents no mergeinfo and an
+ * empty hash represents empty mergeinfo. */
typedef apr_hash_t *svn_mergeinfo_t;
+
+/** A hash mapping paths (@c const char *) to @c svn_mergeinfo_t.
+ *
+ * @note While the keys of #svn_mergeinfo_t are always absolute from the
+ * repository root, the keys of a catalog may be relative to something
+ * else, such as an RA session root.
+ * */
typedef apr_hash_t *svn_mergeinfo_catalog_t;
/** Parse the mergeinfo from @a input into @a *mergeinfo. If no
Modified: subversion/trunk/subversion/include/svn_path.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_path.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_path.h (original)
+++ subversion/trunk/subversion/include/svn_path.h Wed Mar 26 13:24:34 2014
@@ -718,10 +718,10 @@ svn_path_resolve_repos_relative_url(cons
const char *repos_root_url,
apr_pool_t *pool);
-/* Return a copy of @a path, allocated from @a pool, for which control
- * characters have been escaped using the form \NNN (where NNN is the
+/** Return a copy of @a path, allocated from @a pool, for which control
+ * characters have been escaped using the form "\NNN" (where NNN is the
* octal representation of the byte's ordinal value).
- *
+ *
* @since New in 1.9. */
const char *
svn_path_illegal_path_escape(const char *path, apr_pool_t *pool);
Modified: subversion/trunk/subversion/include/svn_ra.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_ra.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_ra.h (original)
+++ subversion/trunk/subversion/include/svn_ra.h Wed Mar 26 13:24:34 2014
@@ -1847,8 +1847,8 @@ svn_ra_get_location_segments(svn_ra_sess
* @c FALSE reporting by switching @a end with @a start.
*
* @note Prior to Subversion 1.9, this function may accept delta handlers
- * from @handler even for empty text deltas. Starting with 1.9, the
- * delta handler / baton return arguments passed to @handler will be
+ * from @a handler even for empty text deltas. Starting with 1.9, the
+ * delta handler / baton return arguments passed to @a handler will be
* #NULL unless there is an actual difference in the file contents between
* the current and the previous call.
*
Modified: subversion/trunk/subversion/include/svn_repos.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Wed Mar 26 13:24:34 2014
@@ -1868,7 +1868,7 @@ svn_repos_get_logs5(svn_repos_t *repos,
/**
* Same as svn_repos_get_logs5(), but with @a move_behavior being set to
- * #svn_fs_move_behavior_no_moves.
+ * #svn_move_behavior_no_moves.
*
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.8 API.
@@ -2038,8 +2038,8 @@ svn_repos_fs_get_mergeinfo(svn_mergeinfo
* switching @a start with @a end.
*
* @note Prior to Subversion 1.9, this function may accept delta handlers
- * from @handler even for empty text deltas. Starting with 1.9, the
- * delta handler / baton return arguments passed to @handler will be
+ * from @a handler even for empty text deltas. Starting with 1.9, the
+ * delta handler / baton return arguments passed to @a handler will be
* #NULL unless there is an actual difference in the file contents between
* the current and the previous call.
*
Modified: subversion/trunk/subversion/include/svn_types.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_types.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_types.h (original)
+++ subversion/trunk/subversion/include/svn_types.h Wed Mar 26 13:24:34 2014
@@ -1062,15 +1062,15 @@ typedef svn_error_t *(*svn_log_message_r
*/
typedef enum svn_move_behavior_t
{
- /* report all moves as ADD with history.
+ /** report all moves as ADD with history.
This also provides backward compatibility with 1.8 clients. */
svn_move_behavior_no_moves = 0,
- /* report all changes, including moves, as they were reported.
+ /** report all changes, including moves, as they were reported.
This is option with the least overhead. */
svn_move_behavior_explicit_moves,
- /* in addition to explicit moves, try to find matching DEL + ADD pairs
+ /** in addition to explicit moves, try to find matching DEL + ADD pairs
and report the ADD in those as moves as well. Which of the eligible
DEL + ADD pairs will be detected is implementation-dependent. */
svn_move_behavior_auto_moves
Modified: subversion/trunk/subversion/include/svn_wc.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_wc.h?rev=1581825&r1=1581824&r2=1581825&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_wc.h (original)
+++ subversion/trunk/subversion/include/svn_wc.h Wed Mar 26 13:24:34 2014
@@ -1831,7 +1831,7 @@ typedef struct svn_wc_conflict_descripti
/** merged version; may contain conflict markers */
const char *merged_file;
- /* For property conflicts, the path to the property reject file. */
+ /** For property conflicts, the path to the property reject file. */
const char *prop_reject_abspath;
/** The operation that exposed the conflict.
@@ -2065,9 +2065,9 @@ svn_wc_conflict_description3_t *
svn_wc_conflict_description_create_text3(const char *local_abspath,
apr_pool_t *result_pool);
-/* Similar to #svn_wc_conflict_description_create_text3, but returns
+/** Similar to svn_wc_conflict_description_create_text3(), but returns
* an svn_wc_conflict_description2_t *.
- *
+ *
* @since New in 1.7.
* @deprecated Provided for backward compatibility with the 1.8 API.
*/
@@ -2109,9 +2109,9 @@ svn_wc_conflict_description_create_prop3
const char *property_name,
apr_pool_t *result_pool);
-/* Similar to #svn_wc_conflict_description_create_prop3, but returns
+/** Similar to svn_wc_conflict_description_create_prop3(), but returns
* an svn_wc_conflict_description2_t *.
- *
+ *
* @since New in 1.7.
* @deprecated Provided for backward compatibility with the 1.8 API.
*/
@@ -2161,9 +2161,9 @@ svn_wc_conflict_description_create_tree3
const svn_wc_conflict_version_t *src_right_version,
apr_pool_t *result_pool);
-/* Similar to #svn_wc_conflict_description_create_tree3, but returns
+/** Similar to svn_wc_conflict_description_create_tree3(), but returns
* an svn_wc_conflict_description2_t *.
- *
+ *
* @since New in 1.7.
* @deprecated Provided for backward compatibility with the 1.8 API.
*/
@@ -2327,7 +2327,7 @@ typedef svn_error_t *(*svn_wc_conflict_r
apr_pool_t *scratch_pool);
-/* Similar to #svn_wc_conflict_resolver_func3_t, but expects an
+/** Similar to #svn_wc_conflict_resolver_func3_t, but expects an
* svn_wc_conflict_description2_t description.
*
* @since New in 1.7.
