svn commit: r1621945 - /subversion/trunk/subversion/include/svn_wc.h

[ju...@apache.org]

Author: julianfoad
Date: Tue Sep  2 08:36:10 2014
New Revision: 1621945

URL: http://svn.apache.org/r1621945
Log:
* subversion/include/svn_wc.h
  (svn_wc_get_changelists): Add a doc string, modeled on the doc string of
    the wrapper function svn_client_get_changelists().

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

Modified: subversion/trunk/subversion/include/svn_wc.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_wc.h?rev=1621945&r1=1621944&r2=1621945&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_wc.h (original)
+++ subversion/trunk/subversion/include/svn_wc.h Tue Sep  2 08:36:10 2014
@@ -8175,7 +8175,17 @@ typedef svn_error_t *(*svn_changelist_re
 
 
 /**
- * ### TODO: Doc string, please.
+ * Beginning at @a local_abspath, crawl to @a depth to discover every path in
+ * or under @a local_abspath which belongs to one of the changelists in @a
+ * changelist_filter (an array of <tt>const char *</tt> changelist names).
+ * If @a changelist_filter is @c NULL, discover paths with any changelist.
+ * Call @a callback_func (with @a callback_baton) each time a
+ * changelist-having path is discovered.
+ *
+ * @a local_abspath is a local WC path.
+ *
+ * If @a cancel_func is not @c NULL, invoke it passing @a cancel_baton
+ * during the recursive walk.
  *
  * @since New in 1.7.
  */