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

Re: svn commit: r14118 - trunk/subversion/include

From: <kfogel_at_collab.net>
Date: 2005-04-12 00:57:40 CEST

maxb@tigris.org writes:
> Log:
> There is nothing whatsoever public about svn_test.h.
>
> * subversion/include/svn_test.h: De-doxygenate.
>
>
> --- trunk/subversion/include/svn_test.h (original)
> +++ trunk/subversion/include/svn_test.h Mon Apr 11 11:14:42 2005
> @@ -1,5 +1,4 @@
> -/**
> - * @copyright
> +/*
> * ====================================================================
> * Copyright (c) 2000-2004 CollabNet. All rights reserved.
> *
> @@ -13,10 +12,6 @@
> * individuals. For exact contribution history, see the revision
> * history and logs, available at http://subversion.tigris.org/.
> * ====================================================================
> - * @endcopyright
> - *
> - * @file svn_test.h
> - * @brief public interfaces for test programs
> */
>
> #ifndef SVN_TEST_H
> @@ -35,22 +30,22 @@
> #endif /* __cplusplus */
>
>
> -/** Baton for any arguments that need to be passed from main() to svn
> - test functions */
> -typedef struct svn_test_opts_t
> +/* Baton for any arguments that need to be passed from main() to svn
> + * test functions */
> + typedef struct svn_test_opts_t

Typically we put the closing "*/" on its own line if we're also doing
a leading " * " on each line.

> -/** All Subversion test programs include an array of @c svn_test_descriptor_t's
> +/* All Subversion test programs include an array of @c svn_test_descriptor_t's
> * (all of our sub-tests) that begins and ends with a @c SVN_TEST_NULL entry.
> */

If we're de-Doxygenating, then it's not just a matter of removing the
extra asterisks, it's also about removing the "@foo" codes and
capitalizing their operands, no?

In other places in this change, you did as above. But then
elsewhere...

> -/** Set @a *editor and @a *edit_baton to an editor that prints its
> - * arguments to @a out_stream. The edit starts at @a path, that is,
> +/* Set *EDITOR and *EDIT_BATON to an editor that prints its
> + * arguments to OUT_STREAM. The edit starts at PATH, that is,
> * @a path will be prepended to the appropriate paths in the output.
> - * Allocate the editor in @a pool.
> + * Allocate the editor in POOL.
>
> [...]

...you did it the other way, the way I expected.

?

-Karl

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Apr 12 01:27:17 2005

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