svn commit: r1458475 - /subversion/trunk/subversion/include/svn_path.h

[cm...@apache.org]

Author: cmpilato
Date: Tue Mar 19 19:43:26 2013
New Revision: 1458475

URL: http://svn.apache.org/r1458475
Log:
* subversion/include/svn_path.h
  (svn_path_is_repos_relative_url,
   svn_path_resolve_repos_relative_url): Docstring updates only.

Modified:
    subversion/trunk/subversion/include/svn_path.h

Modified: subversion/trunk/subversion/include/svn_path.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_path.h?rev=1458475&r1=1458474&r2=1458475&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_path.h (original)
+++ subversion/trunk/subversion/include/svn_path.h Tue Mar 19 19:43:26 2013
@@ -677,10 +677,9 @@ svn_path_cstring_to_utf8(const char **pa
  * @{
  */
 
-
 /**
- * Return true iff @a path is a repository-relative URL: specifically that
- * it starts with the characters "^/"
+ * Return @c TRUE iff @a path is a repository-relative URL:  specifically
+ * that it starts with the characters "^/"
  *
  * @a path is in UTF-8 encoding.
  *
@@ -694,22 +693,20 @@ svn_path_is_repos_relative_url(const cha
 
 /**
  * Set @a absolute_url to the absolute URL represented by @a relative_url
- * relative to @a repos_root_url.  @a absolute_url will be allocated in
- * @a pool.
- *
- * @a absolute_url will end with a peg revision specifier if @a relative_url
- * did.
+ * relative to @a repos_root_url, preserving any peg revision
+ * specifier present in @a relative_url.  Allocate @a absolute_url
+ * from @a pool.
  *
  * @a relative_url is in repository-relative syntax: "^/[REL-URL][@PEG]"
  *
- * @a repos_root_url is the absolute url of the repository root.
+ * @a repos_root_url is the absolute URL of the repository root.
  *
  * All strings are in UTF-8 encoding.
  *
  * @a repos_root_url and @a relative_url do not have to be properly
- * URI-encoded, canonical, or valid in any other way.  The caller is expected
- * to perform canonicalization on @a absolute_url after the call to the
- * function.
+ * URI-encoded, canonical, or valid in any other way.  The caller is
+ * expected to perform canonicalization on @a absolute_url after the
+ * call to the function.
  *
  * @since New in 1.8.
  */
@@ -719,7 +716,6 @@ svn_path_resolve_repos_relative_url(cons
                                     const char *repos_root_url,
                                     apr_pool_t *pool);
 
-
 /** @} */
 
 #ifdef __cplusplus