[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [PATCH] Comment consistencies in subversion/include/*.h

From: <kfogel_at_collab.net>
Date: 2005-03-11 22:39:17 CET

"Brian W. Fitzpatrick" <fitz@collab.net> writes:
> Index: subversion/include/svn_test.h
> ===================================================================
> --- subversion/include/svn_test.h (revision 13380)
> +++ subversion/include/svn_test.h (working copy)
> @@ -98,7 +98,7 @@
> *
> * @a editor_name is a name for the editor, a string that will be
> * prepended to the editor output as shown below. @a editor_name may
> - * be the empty string, but it may not be null.
> + * be the empty string.
> *
> * @a verbose is a flag for specifying whether or not your want all the
> * nitty gritty details displayed. When @a verbose is @c FALSE, each

+1

> Index: subversion/include/svn_string.h
> ===================================================================
> --- subversion/include/svn_string.h (revision 13380)
> +++ subversion/include/svn_string.h (working copy)
> @@ -51,14 +51,6 @@
> * which means that @c strlen(s->data) does not have to equal @c
> * s->len. The null terminator is provided to make it easier to
> * pass @c s->data to C string interfaces.
> - *
> - *
> - * 2. Non-null input:
> - *
> - * All the functions below assume their input data is non-null,
> - * unless otherwise documented, and may seg fault if passed
> - * null. The input data may *contain* null bytes, of course, just
> - * the data pointer itself must not be null.
> */

I think this general comment is worth leaving, though.

> @@ -295,8 +287,6 @@
> *
> * If @a chop_whitespace is true, then remove leading and trailing
> * whitespace from the returned strings.
> - *
> - * @a input may not be null.
> */
> apr_array_header_t *svn_cstring_split (const char *input,
> const char *sep_chars,

+1

> Index: subversion/include/svn_io.h
> ===================================================================
> --- subversion/include/svn_io.h (revision 13380)
> +++ subversion/include/svn_io.h (working copy)
> @@ -84,8 +84,6 @@
> * then the @c APR_DELONCLOSE flag will be used when opening the file. The
> * @c APR_BUFFERED flag will always be used.
> *
> - * @a suffix may not be null.
> - *
> * The first attempt will just append @a suffix. If the result is not
> * a unique name, then subsequent attempts will append a dot,
> * followed by an iteration number ("2", then "3", and so on),

+1 on this and all the other changes.

-Karl

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Mar 11 23:00:25 2005

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.