Author: julianfoad
Date: Mon Jun 6 08:48:23 2011
New Revision: 1132550
URL: http://svn.apache.org/viewvc?rev=1132550&view=rev
Log:
Fix cross-references, Doxygen mark-up and other simple errors in doc strings.
* subversion/include/svn_client.h
(svn_client_commit_item_create): Fix white space around 'SVN_DEPRECATED'.
(svn_client_add4): Correct a cross-reference. Fix Doxygen mark-up.
(svn_client_mkdir3, svn_client_delete3, svn_client_import3,
svn_client_copy5, svn_client_move5, svn_client_propset3): Tweak wording.
(svn_client_commit4): Tweak wording. Fix Doxygen mark-up.
(svn_client_status_t): Correct a cross-reference. Fix grammar.
(svn_client_lock): Correct a cross-reference. Fix Doxygen mark-up.
* subversion/include/svn_opt.h
(svn_opt_parse_path): Fix Doxygen mark-up to display a list.
* subversion/include/svn_props.h
(svn_prop_get_value): Fix Doxygen mark-up.
* subversion/include/svn_repos.h
(svn_repos_notify_t, svn_repos_notify_func_t): Fix Doxygen mark-up.
* subversion/include/svn_string.h
Add a missing Doxygen end-of-group tag. Remove redundant comments that
repeated the Doxygen group comments.
* subversion/include/svn_version.h
(svn_version_t): Remove a spurious backslash character.
* subversion/include/svn_wc.h
(svn_wc_mark_missing_deleted, svn_wc_delete4): Fix Doxygen mark-up.
* subversion/include/svn_xml.h
(svn_xml_make_header): Fix Doxygen mark-up.
* subversion/include/private/svn_wc_private.h
(svn_wc__min_max_revisions): Fix Doxygen mark-up.
Modified:
subversion/trunk/subversion/include/private/svn_wc_private.h
subversion/trunk/subversion/include/svn_client.h
subversion/trunk/subversion/include/svn_opt.h
subversion/trunk/subversion/include/svn_props.h
subversion/trunk/subversion/include/svn_repos.h
subversion/trunk/subversion/include/svn_string.h
subversion/trunk/subversion/include/svn_version.h
subversion/trunk/subversion/include/svn_wc.h
subversion/trunk/subversion/include/svn_xml.h
Modified: subversion/trunk/subversion/include/private/svn_wc_private.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_wc_private.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_wc_private.h (original)
+++ subversion/trunk/subversion/include/private/svn_wc_private.h Mon Jun 6
08:48:23 2011
@@ -809,9 +809,9 @@ svn_wc__node_get_lock_tokens_recursive(a
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
-/* Set @ *min_revision and @ *max_revision to the lowest and highest revision
+/* Set @a *min_revision and @a *max_revision to the lowest and highest revision
* numbers found within @a local_abspath, using context @a wc_ctx.
- * If @ committed is TRUE, set @a *min_revision and @a *max_revision
+ * If @a committed is TRUE, set @a *min_revision and @a *max_revision
* to the lowest and highest comitted (i.e. "last changed") revision numbers,
* respectively. Use @a scratch_pool for temporary allocations.
*
Modified: subversion/trunk/subversion/include/svn_client.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_client.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_client.h (original)
+++ subversion/trunk/subversion/include/svn_client.h Mon Jun 6 08:48:23 2011
@@ -563,7 +563,8 @@ svn_client_commit_item3_create(apr_pool_
*
* @deprecated Provided for backward compatibility with the 1.5 API.
*/
-SVN_DEPRECATED svn_error_t *
+SVN_DEPRECATED
+svn_error_t *
svn_client_commit_item_create(const svn_client_commit_item3_t **item,
apr_pool_t *pool);
@@ -1455,7 +1456,7 @@ svn_client_switch(svn_revnum_t *result_r
/**
* Schedule a working copy @a path for addition to the repository.
*
- * If @a depth is svn_depth_empty, add just @a path and nothing
+ * If @a depth is #svn_depth_empty, add just @a path and nothing
* below it. If #svn_depth_files, add @a path and any file
* children of @a path. If #svn_depth_immediates, add @a path, any
* file children, and any immediate subdirectories (but nothing
@@ -1489,7 +1490,7 @@ svn_client_switch(svn_revnum_t *result_r
*
* If @a add_parents is TRUE, recurse up @a path's directory and look for
* a versioned directory. If found, add all intermediate paths between it
- * and @a path. If not found, return #SVN_ERR_CLIENT_NO_VERSIONED_PARENTS.
(### What?)
+ * and @a path. If not found, return #SVN_ERR_CLIENT_NO_VERSIONED_PARENT.
*
* @par Important:
* This is a *scheduling* operation. No changes will
@@ -1601,8 +1602,8 @@ svn_client_mkdir4(const apr_array_header
apr_pool_t *pool);
/**
- * Similar to svn_client_mkdir4(), but returns the @a commit_info_p directly,
- * rather than through @a commit_callback.
+ * Similar to svn_client_mkdir4(), but returns the commit info in
+ * @a *commit_info_p rather than through a callback function.
*
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -1707,8 +1708,8 @@ svn_client_delete4(const apr_array_heade
apr_pool_t *pool);
/**
- * Similar to svn_client_delete4(), but returns the @a commit_info_p directly,
- * rather than through @a commit_callback.
+ * Similar to svn_client_delete4(), but returns the commit info in
+ * @a *commit_info_p rather than through a callback function.
*
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -1834,8 +1835,8 @@ svn_client_import4(const char *path,
apr_pool_t *pool);
/**
- * Similar to svn_client_import4(), but returns the @a commit_info_p directly,
- * rather than through @a commit_callback.
+ * Similar to svn_client_import4(), but returns the commit info in
+ * @a *commit_info_p rather than through a callback function.
*
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -1975,8 +1976,8 @@ svn_client_commit5(const apr_array_heade
apr_pool_t *pool);
/**
- * Similar to svn_client_commit5(), but returns the @a commit_info_p directly,
- * rather than through @a commit_callback. Does not make use of
+ * Similar to svn_client_commit5(), but returns the commit info in
+ * @a *commit_info_p rather than through a callback function. Does not use
* #svn_wc_notify_commit_copied or #svn_wc_notify_commit_copied_replaced
* (preferring #svn_wc_notify_commit_added and
* #svn_wc_notify_commit_replaced, respectively, instead).
@@ -1985,7 +1986,7 @@ svn_client_commit5(const apr_array_heade
* #SVN_INVALID_REVNUM, then the commit was a no-op; nothing needed to
* be committed.
*
- * Sets @ commit_as_operations to FALSE to match Subversion 1.6's behavior.
+ * Sets @a commit_as_operations to FALSE to match Subversion 1.6's behavior.
*
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -2193,14 +2194,14 @@ typedef struct svn_client_status_t
/** Set to the user name of the youngest commit, or @c NULL if not
* out of date or non-existent. Because a non-existent @c
* svn:author property has the same behavior as an out-of-date
- * working copy, examine @c ood_last_cmt_rev to determine whether
+ * working copy, examine @c ood_changed_rev to determine whether
* the working copy is out of date. */
const char *ood_changed_author;
/** @} */
- /** Reserved for libsvn_clients internal use; this value is only to be used
for
- * libsvn_client backwards compatibility wrappers, This value may be NULL or
+ /** Reserved for libsvn_client's internal use; this value is only to be used
for
+ * libsvn_client backwards compatibility wrappers. This value may be NULL or
* to other data in future versions. */
const void *backwards_compatibility_baton;
@@ -3863,8 +3864,8 @@ svn_client_copy6(const apr_array_header_
apr_pool_t *pool);
/**
- * Similar to svn_client_copy6(), but returns the @a commit_info_p directly,
- * rather than through @a commit_callback.
+ * Similar to svn_client_copy6(), but returns the commit info in
+ * @a *commit_info_p rather than through a callback function.
*
* @since New in 1.6.
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -4047,8 +4048,8 @@ svn_client_move6(const apr_array_header_
apr_pool_t *pool);
/**
- * Similar to svn_client_move6(), but returns the @a commit_info_p directly,
- * rather than through @a commit_callback.
+ * Similar to svn_client_move6(), but returns the commit info in
+ * @a *commit_info_p rather than through a callback function.
*
* A WC-to-WC move will include any modified and/or unversioned children.
* @a force is ignored.
@@ -4256,7 +4257,8 @@ svn_client_propset_local(const char *pro
/**
* An amalgamation of svn_client_propset_local() and
* svn_client_propset_remote() that takes only a single target, and
- * returns the @a commit_info_p directly rather than through a callback.
+ * returns the commit info in @a *commit_info_p rather than through a
+ * callback function.
*
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.6 API.
@@ -4274,6 +4276,7 @@ svn_client_propset3(svn_commit_info_t **
const apr_hash_t *revprop_table,
svn_client_ctx_t *ctx,
apr_pool_t *pool);
+
/**
* Like svn_client_propset3(), but with @a base_revision_for_url
* always #SVN_INVALID_REVNUM; @a commit_info_p always @c NULL; @a
@@ -5120,10 +5123,10 @@ svn_client_get_changelists(const char *p
* be stored in the working copy if the targets are WC paths.
*
* For each target @a ctx->notify_func2/notify_baton2 will be used to indicate
- * whether it was locked. An action of #svn_wc_notify_state_locked (### what?)
+ * whether it was locked. An action of #svn_wc_notify_locked
* means that the path was locked. If the path was not locked because
* it was out of date or there was already a lock in the repository,
- * the notification function will be called with @c
+ * the notification function will be called with
* #svn_wc_notify_failed_lock, and the error passed in the notification
* structure.
*
Modified: subversion/trunk/subversion/include/svn_opt.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_opt.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_opt.h (original)
+++ subversion/trunk/subversion/include/svn_opt.h Mon Jun 6 08:48:23 2011
@@ -622,25 +622,25 @@ svn_opt_parse_all_args(apr_array_header_
*
* Some examples would be:
*
- * "foo/bar" -> "foo/bar", (unspecified)
- * "foo/bar@13" -> "foo/bar", (number, 13)
- * "foo/bar@HEAD" -> "foo/bar", (head)
- * "foo/bar@{1999-12-31}" -> "foo/bar", (date, 1999-12-31)
- * "http://a/b@27"; -> "http://a/b";, (number, 27)
- * "http://a/b@COMMITTED"; -> "http://a/b";, (committed) [*]
- * "http://a/b@{1999-12-31} -> "http://a/b";, (date, 1999-12-31)
- * "http://a/b@%7B1999-12-31%7D -> "http://a/b";, (date, 1999-12-31)
- * "foo/bar@1:2" -> error
- * "foo/bar@baz" -> error
- * "foo/bar@" -> "foo/bar", (base)
- * "foo/@bar@" -> "foo/@bar", (base)
- * "foo/bar/@13" -> "foo/bar/", (number, 13)
- * "foo/bar@@13" -> "foo/bar@", (number, 13)
- * "foo/@bar@HEAD" -> "foo/@bar", (head)
- * "foo@/bar" -> "foo@/bar", (unspecified)
- * "foo@HEAD/bar" -> "foo@HEAD/bar", (unspecified)
- * "@foo/bar" -> error
- * "@foo/bar@" -> "@foo/bar", (unspecified)
+ * - "foo/bar" -> "foo/bar", (unspecified)
+ * - "foo/bar@13" -> "foo/bar", (number, 13)
+ * - "foo/bar@HEAD" -> "foo/bar", (head)
+ * - "foo/bar@{1999-12-31}" -> "foo/bar", (date, 1999-12-31)
+ * - "http://a/b@27"; -> "http://a/b";, (number, 27)
+ * - "http://a/b@COMMITTED"; -> "http://a/b";, (committed) [*]
+ * - "http://a/b@{1999-12-31}"; -> "http://a/b";, (date, 1999-12-31)
+ * - "http://a/b@%7B1999-12-31%7D"; -> "http://a/b";, (date, 1999-12-31)
+ * - "foo/bar@1:2" -> error
+ * - "foo/bar@baz" -> error
+ * - "foo/bar@" -> "foo/bar", (base)
+ * - "foo/@bar@" -> "foo/@bar", (base)
+ * - "foo/bar/@13" -> "foo/bar/", (number, 13)
+ * - "foo/bar@@13" -> "foo/bar@", (number, 13)
+ * - "foo/@bar@HEAD" -> "foo/@bar", (head)
+ * - "foo@/bar" -> "foo@/bar", (unspecified)
+ * - "foo@HEAD/bar" -> "foo@HEAD/bar", (unspecified)
+ * - "@foo/bar" -> error
+ * - "@foo/bar@" -> "@foo/bar", (unspecified)
*
* [*] Syntactically valid but probably not semantically useful.
*
Modified: subversion/trunk/subversion/include/svn_props.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_props.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_props.h (original)
+++ subversion/trunk/subversion/include/svn_props.h Mon Jun 6 08:48:23 2011
@@ -122,7 +122,7 @@ svn_prop_hash_dup(apr_hash_t *hash,
/**
* Return the value of property @a prop_name as it is in @a properties,
* with values <tt>const svn_string_t</tt>. If @a prop_name is not
- * in @a properties or @ properties is NULL, return NULL.
+ * in @a properties or @a properties is NULL, return NULL.
*
* @since New in 1.7.
*/
Modified: subversion/trunk/subversion/include/svn_repos.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Mon Jun 6 08:48:23 2011
@@ -275,7 +275,7 @@ typedef struct svn_repos_notify_t
svn_revnum_t new_revision;
/** For #svn_repos_notify_load_commited_rev, the source revision, if
- different from #new_revision, otherwise #SVN_INVALID_REVNUM.
+ different from @a new_revision, otherwise #SVN_INVALID_REVNUM.
For #svn_repos_notify_load_txn_start, the source revision. */
svn_revnum_t old_revision;
@@ -292,7 +292,7 @@ typedef struct svn_repos_notify_t
} svn_repos_notify_t;
/** Callback for providing notification from the repository.
- * Returns @a void. Justification: success of an operation is not dependent
+ * Returns @c void. Justification: success of an operation is not dependent
* upon successful notification of that operation.
*
* @since New in 1.7. */
Modified: subversion/trunk/subversion/include/svn_string.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_string.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_string.h (original)
+++ subversion/trunk/subversion/include/svn_string.h Mon Jun 6 08:48:23 2011
@@ -120,8 +120,7 @@ typedef struct svn_stringbuf_t
} svn_stringbuf_t;
-/** svn_string_t functions.
- *
+/**
* @defgroup svn_string_svn_string_t svn_string_t functions
* @{
*/
@@ -177,9 +176,10 @@ svn_string_first_non_whitespace(const sv
apr_size_t
svn_string_find_char_backward(const svn_string_t *str, char ch);
+/** @} */
+
-/** svn_stringbuf_t functions.
- *
+/**
* @defgroup svn_string_svn_stringbuf_t svn_stringbuf_t functions
* @{
*/
@@ -322,9 +322,8 @@ svn_string_compare_stringbuf(const svn_s
/** @} */
-/** C strings.
- *
- * @defgroup svn_string_cstrings c string functions
+/**
+ * @defgroup svn_string_cstrings C string functions
* @{
*/
Modified: subversion/trunk/subversion/include/svn_version.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_version.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_version.h (original)
+++ subversion/trunk/subversion/include/svn_version.h Mon Jun 6 08:48:23 2011
@@ -154,7 +154,7 @@ typedef struct svn_version_t
int patch; /**< Patch number */
/**
- * The version tag (#SVN_VER_NUMTAG).\ Must always point to a
+ * The version tag (#SVN_VER_NUMTAG). Must always point to a
* statically allocated string.
*/
const char *tag;
Modified: subversion/trunk/subversion/include/svn_wc.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_wc.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_wc.h (original)
+++ subversion/trunk/subversion/include/svn_wc.h Mon Jun 6 08:48:23 2011
@@ -3245,7 +3245,7 @@ svn_wc_walk_entries(const char *path,
/** Mark missing @a path as 'deleted' in its @a parent's list of
- * entries. @ path should be a directory that is both deleted (via
+ * entries. @a path should be a directory that is both deleted (via
* svn_wc_delete4) and removed (via a system call). This function
* should only be called during post-commit processing following a
* successful commit editor drive.
@@ -4212,7 +4212,7 @@ svn_wc_copy(const char *src,
* repository on the next commit. If @a local_abspath refers to a
* directory, then a recursive deletion will occur. @a wc_ctx must hold
* a write lock for the parent of @a local_abspath, @a local_abspath itself
- * and everything below @ local_abspath.
+ * and everything below @a local_abspath.
*
* If @a keep_local is FALSE, this function immediately deletes all files,
* modified and unmodified, versioned and of @a delete_unversioned is TRUE,
Modified: subversion/trunk/subversion/include/svn_xml.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_xml.h?rev=1132550&r1=1132549&r2=1132550&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_xml.h (original)
+++ subversion/trunk/subversion/include/svn_xml.h Mon Jun 6 08:48:23 2011
@@ -280,8 +280,9 @@ svn_xml_hash_atts_overlaying(const char
/** Create an XML header and return it in @a *str.
*
* Fully-formed XML documents should start out with a header,
- * something like
+ * something like <pre>
* \<?xml version="1.0" encoding="utf-8"?\>
+ * </pre>
*
* This function returns such a header. @a *str must either be @c NULL, in
* which case a new string is created, or it must point to an existing
