You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by hw...@apache.org on 2010/09/16 14:39:36 UTC
svn commit: r997725 - /subversion/trunk/subversion/include/svn_client.h
Author: hwright
Date: Thu Sep 16 12:39:36 2010
New Revision: 997725
URL: http://svn.apache.org/viewvc?rev=997725&view=rev
Log:
* subversion/include/svn_client.h
(svn_client_checkout3): Attempt to improve the docs about the return value.
Suggested by: rhuijben
Modified:
subversion/trunk/subversion/include/svn_client.h
Modified: subversion/trunk/subversion/include/svn_client.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_client.h?rev=997725&r1=997724&r2=997725&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_client.h (original)
+++ subversion/trunk/subversion/include/svn_client.h Thu Sep 16 12:39:36 2010
@@ -1067,13 +1067,15 @@ svn_client_args_to_target_array(apr_arra
* notification.
* @param[in] pool Used for any temporary allocation.
*
- * @return #SVN_ERR_UNSUPPORTED_FEATURE if @a URL refers to a file rather
+ * @return A pointer to an #svn_error_t of the type (this list is not
+ * exhaustive): <br>
+ * #SVN_ERR_UNSUPPORTED_FEATURE if @a URL refers to a file rather
* than a directory; <br>
* #SVN_ERR_RA_ILLEGAL_URL if @a URL does not exist; <br>
* #SVN_ERR_CLIENT_BAD_REVISION if @a revision is not one of
* #svn_opt_revision_number, #svn_opt_revision_head, or
- * #svn_opt_revision_date; <br>
- * #SVN_NO_ERROR otherwise.
+ * #svn_opt_revision_date. <br>
+ * If no error occurred, return #SVN_NO_ERROR.
*
* @since New in 1.5.
*