subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From danie...@apache.org
Subject svn commit: r1305857 - in /subversion/trunk/subversion: include/svn_delta.h include/svn_diff.h include/svn_sorts.h libsvn_client/client.h
Date Tue, 27 Mar 2012 14:52:00 GMT
Author: danielsh
Date: Tue Mar 27 14:52:00 2012
New Revision: 1305857

URL: http://svn.apache.org/viewvc?rev=1305857&view=rev
Log:
Docstring improvements for qsort() callers.

* subversion/include/svn_diff.h
  (svn_patch_t.hunks):
* subversion/include/svn_sorts.h
  (svn_sort_compare_paths, svn_sort_compare_ranges):
* subversion/include/svn_delta.h
  (svn_delta_path_driver):
* subversion/libsvn_client/client.h
  (svn_client__sort_commit_item_urls):
    Improve docstrings.

Modified:
    subversion/trunk/subversion/include/svn_delta.h
    subversion/trunk/subversion/include/svn_diff.h
    subversion/trunk/subversion/include/svn_sorts.h
    subversion/trunk/subversion/libsvn_client/client.h

Modified: subversion/trunk/subversion/include/svn_delta.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_delta.h?rev=1305857&r1=1305856&r2=1305857&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_delta.h (original)
+++ subversion/trunk/subversion/include/svn_delta.h Tue Mar 27 14:52:00 2012
@@ -1292,6 +1292,8 @@ typedef svn_error_t *(*svn_delta_path_dr
  * Use @a revision as the revision number passed to intermediate
  * directory openings.
  *
+ * Each path in @a paths is a const char *.
+ *
  * Use @a pool for all necessary allocations.
  */
 svn_error_t *

Modified: subversion/trunk/subversion/include/svn_diff.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_diff.h?rev=1305857&r1=1305856&r2=1305857&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_diff.h (original)
+++ subversion/trunk/subversion/include/svn_diff.h Tue Mar 27 14:52:00 2012
@@ -1045,7 +1045,7 @@ typedef struct svn_patch_t {
   const char *new_filename;
 
   /**
-   * An array containing an svn_diff_hunk_t object for each hunk parsed
+   * An array containing an svn_diff_hunk_t * for each hunk parsed
    * from the patch. */
   apr_array_header_t *hunks;
 

Modified: subversion/trunk/subversion/include/svn_sorts.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_sorts.h?rev=1305857&r1=1305856&r2=1305857&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_sorts.h (original)
+++ subversion/trunk/subversion/include/svn_sorts.h Tue Mar 27 14:52:00 2012
@@ -112,9 +112,9 @@ svn_sort_compare_revisions(const void *a
 
 
 /**
- * Compare two @c const char * paths, returning an integer greater
- * than, equal to, or less than 0, using the same comparison rules as
- * are used by svn_path_compare_paths().
+ * Compare two @c const char * paths, @a *a and @a *b, returning an
+ * integer greater than, equal to, or less than 0, using the same
+ * comparison rules as are used by svn_path_compare_paths().
  *
  * This function is compatible for use with qsort().
  *
@@ -125,13 +125,13 @@ svn_sort_compare_paths(const void *a,
                        const void *b);
 
 /**
- * Compare two @c svn_merge_range_t *'s, returning an integer greater
- * than, equal to, or less than 0 if the first range is greater than,
- * equal to, or less than, the second range.
+ * Compare two @c svn_merge_range_t *'s, @a *a and @a *b, returning an
+ * integer greater than, equal to, or less than 0 if the first range is
+ * greater than, equal to, or less than, the second range.
  *
  * Both @c svn_merge_range_t *'s must describe forward merge ranges.
  *
- * If @a a and @a b intersect then the range with the lower start revision
+ * If @a *a and @a *b intersect then the range with the lower start revision
  * is considered the lesser range.  If the ranges' start revisions are
  * equal then the range with the lower end revision is considered the
  * lesser range.

Modified: subversion/trunk/subversion/libsvn_client/client.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_client/client.h?rev=1305857&r1=1305856&r2=1305857&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_client/client.h (original)
+++ subversion/trunk/subversion/libsvn_client/client.h Tue Mar 27 14:52:00 2012
@@ -842,7 +842,7 @@ svn_client__get_copy_committables(svn_cl
                                   apr_pool_t *scratch_pool);
 
 /* A qsort()-compatible sort routine for sorting an array of
-   svn_client_commit_item_t's by their URL member. */
+   svn_client_commit_item_t *'s by their URL member. */
 int svn_client__sort_commit_item_urls(const void *a, const void *b);
 
 



Mime
View raw message