svn commit: r13192 - trunk/subversion/include

Author: kfogel
Date: Mon Feb 28 11:37:47 2005
New Revision: 13192

Modified:
   trunk/subversion/include/svn_wc.h
Log:
Follow up to r13190:

* subversion/include/svn_wc.h
  (svn_wc_status_func_t, svn_wc_relocation_validator_t): Document
    baton parameter.  Yes, maybe it should be obvious, but there's
    a reason we have http://subversion.tigris.org/faq.html#baton. 


Modified: trunk/subversion/include/svn_wc.h
Url: 
http://svn.collab.net/viewcvs/svn/trunk/subversion/include/svn_wc.h?view=diff&rev=13192&p1=trunk/subversion/include/svn_wc.h&r1=13191&p2=trunk/subversion/include/svn_wc.h&r2=13192
==============================================================================
--- trunk/subversion/include/svn_wc.h   (original)
+++ trunk/subversion/include/svn_wc.h   Mon Feb 28 11:37:47 2005
@@ -1397,8 +1397,11 @@
 
 
 
-/** A callback for reporting an @c svn_wc_status_t item @a status for
-    @a path. */
+/** A callback for reporting a @a status about @a path. 
+ *
+ * @a baton is a closure object; it should be provided by the
+ * implementation, and passed by the caller.
+ */
 typedef void (*svn_wc_status_func_t) (void *baton,
                                       const char *path,
                                       svn_wc_status_t *status);
@@ -2375,6 +2378,9 @@
  *
  * Called for each relocated file/directory.  @a uuid contains the
  * expected repository UUID, @a url contains the tentative URL.
+ *
+ * @a baton is a closure object; it should be provided by the
+ * implementation, and passed by the caller.
  */
 typedef svn_error_t *(*svn_wc_relocation_validator_t) (void *baton,
                                                        const char *uuid,