Re: [PATCH] Fix issue 1037 (Repository UUIDs)

mark benedetto king wrote:

On Wed, Jan 29, 2003 at 06:55:50PM +0100, Branko ?ibej wrote:
  

mark benedetto king wrote:
    

+/* UUID manipulation. */
+
+/** Populate @a *uuid with the UUID associated with @a fs.
+ *
+ * Populate @a *uuid with the UUID associated with @a fs.
+ */

Why the repeated docstrings? If we want the brief descriptions repeated,
we should say so in doxygen.conf (the REPEAT_BRIEF option). It's
currently set to NO.

I must confess that I tried to simply intuit what the docstrings
should be from looking at others in the code. I was not aware of
the REPEAT_BRIEF option. However, and this probably further
illustrates my ignorance, wouldn't turning *off* REPEAT_BRIEF
*necessitate* repeating the docstrings? My assumption has been
that the first one shows up somewhere as the short description
and the second one shows up somewhere else as the long description.

Your assumption is corect, but we really don't want to have duplicate
docstrings like that. I'd propose to set REPEAT_BRIEF to YES, and
gradually modify the long descriptions to be a logical continuation of
the short ones.

-- 
Brane Čibej   brane_at_xbc.nu   http://www.xbc.nu/brane/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org