Author: stefan2
Date: Tue Apr 18 11:53:01 2017
New Revision: 1791771
URL: http://svn.apache.org/viewvc?rev=1791771&view=rev
Log:
* subversion/include/svn_ra.h
(svn_ra_dirent_receiver_t,
svn_ra_list): Fix docstrings. No functional change.
Found by: julianfoad
Modified:
subversion/trunk/subversion/include/svn_ra.h
Modified: subversion/trunk/subversion/include/svn_ra.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_ra.h?rev=1791771&r1=1791770&r2=1791771&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_ra.h (original)
+++ subversion/trunk/subversion/include/svn_ra.h Tue Apr 18 11:53:01 2017
@@ -1130,12 +1130,12 @@ svn_ra_get_dir(svn_ra_session_t *session
apr_pool_t *pool);
/**
- * Callback type to be used with @c svn_repos_list. It will be invoked for
+ * Callback type to be used with @a svn_ra_list. It will be invoked for
* every directory entry found.
*
- * The full path of the entry is given in @a path and @a dirent contains
- * various additional information. If @c svn_repos_list has been called
- * with @a path_info_only set, only the @a kind element of this struct
+ * The full path of the entry is given in @a rel_path and @a dirent contains
+ * various additional information. If @a svn_repos_list has been called
+ * with @c path_info_only set, only the @c kind element of this struct
* will be valid.
*
* @a baton is the user-provided receiver baton. @a scratch_pool may be
@@ -1152,12 +1152,12 @@ typedef svn_error_t *(* svn_ra_dirent_re
* Efficiently list everything within a sub-tree. Specify a glob pattern
* to search for specific files and folders.
*
- * Walk the sub-tree starting at @a path under @a root up to the given
- * @a depth. For each directory entry found, @a receiver will be called
- * with @a receiver_baton. The starting @a path will be reported as well.
- * Because retrieving all elements of a @c svn_dirent_t can be expensive,
- * you may set @a path_info_only to receive only the path name and the node
- * kind.
+ * In @a session, walk the sub-tree starting at @a path at @a revision down
+ * to the given @a depth. For each directory entry found, @a receiver will
+ * be called with @a receiver_baton. The starting @a path will be reported
+ * as well. Because retrieving elements of a @c svn_dirent_t can be
+ * expensive, you need to select them individually via flags set in
+ * @a dirent_fields.
*
* @a patterns is an optional array of <tt>const char *</tt>. If it is
* not @c NULL, only those directory entries will be reported whose last
@@ -1165,12 +1165,6 @@ typedef svn_error_t *(* svn_ra_dirent_re
* @c apr_fnmatch for glob matching and requiring '.' to matched by dots
* in the path.
*
- * If @a authz_read_func is not @c NULL, this function will neither report
- * entries nor recurse into directories that the user has no access to.
- *
- * Cancellation support is provided in the usual way through the optional
- * @a cancel_func and @a cancel_baton.
- *
* @a path must point to a directory and @a depth must be at least
* @c svn_depth_empty.
*
