Minor Documentation Patch

[Sam TH <sa...@uchicago.edu>]

While reading all the svn_*.h files, I corrected a couple
documentation errors.  

* svn_delta.h (delete_item): Removed obselete documentation.

* svn_delta.h (svn_delta_compose_editors): Update documentation to
reflect the actual parameter names.

Index: svn_delta.h
===================================================================
RCS file: /cvs/subversion/subversion/include/svn_delta.h,v
retrieving revision 1.137
diff -u -r1.137 svn_delta.h
--- svn_delta.h	2001/01/30 23:06:20	1.137
+++ svn_delta.h	2001/02/03 10:16:43
@@ -384,15 +384,9 @@
 
   /* Deleting things.  */
 
-  /* Remove the directory entry named NAME.  */
-  /* FIXME: this used to be just delete(), but was changed to avoid
-   * gratuitous incompatibility with C++, where `delete' is a reserved
-   * keyword.  Unfortunately, remove() is taken by the standard C
-   * library.  The compromise is delete_item(), but if anyone can
-   * think of a better name, tags-query-replace is your friend. :-)
-   * If you're reading this comment long after 22 Dec 2000, then
-   * apparently no one has thought of a better name, so it's probably
-   * time to remove the comment. */
+  /* Remove the directory entry named NAME.  This isn't named delete
+   to avoid incompatibility with C++, and isn't named remove because
+   that's used by the C library. */
   svn_error_t *(*delete_item) (svn_string_t *name,
                                void *parent_baton);
 
@@ -512,16 +506,17 @@
 /* Compose EDITOR_1 and its baton with EDITOR_2 and its root dir
  * baton.
  *
- * Returns a new editor in E which each function FUN calls
- * EDITOR_1->FUN and then EDITOR_2->FUN, with the corresponding batons.
+ * Returns a new editor in NEW_EDITOR which each function FUN calls
+ * EDITOR_1->FUN and then EDITOR_2->FUN, with the corresponding
+ * batons.
  * 
- * If EDITOR_1->FUN returns error, that error is returned from E->FUN
- * and EDITOR_2->FUN is never called; otherwise E->FUN's return value
- * is the same as EDITOR_2->FUN's.
+ * If EDITOR_1->FUN returns error, that error is returned from
+ * NEW_EDITOR->FUN and EDITOR_2->FUN is never called; otherwise
+ * NEW_EDITOR->FUN's return value is the same as EDITOR_2->FUN's.
  *
  * If an editor function is null, it is simply never called, and this
  * is not an error.
- */
+ */ 
 void
 svn_delta_compose_editors (const svn_delta_edit_fns_t **new_editor,
                            void **new_root_dir_baton,

           
	sam th		     
	sam@uchicago.edu
	http://www.abisource.com/~sam/
	GnuPG Key:  
	http://www.abisource.com/~sam/key