[PATCH] Fix Doxygen group comments

[Marcel Gosselin <ma...@polymtl.ca>]

Here is a patch that fixes some Doxygen usage. The comments that used 
the following form
    /** @{ */
    /** Here is some text that will not be displayed or displayed at the 
wrong place */
    void fct1();
    void fct2();
    /** @} */
gave the wrong display. Some documentation was hidden because the 
parsing of some of these tags
did not give the expected result.

The right way to do this is like this
   /** @name Group name
         My brief description

         Longer description.

         @note Some note
   */
   /** @{ */

The @{ can be in the same /** */ as the previous info but it needs to be 
at the end and either a @name or @defgroup should appear before it.

Here is the log message
[[[
Improve Doxygen group usage by placing the "@{" just before the first 
element of the
group and by adding an "@name" group name.

* subversion\include\svn_fs.h
* subversion\include\svn_dav.h
* subversion\include\svn_subst.h
* subversion\include\svn_config.h
* subversion\include\svn_client.h
* subversion\include\svn_auth.h
  Move the "@{" group tags and add "@name" to those groups.
]]]

Re: [PATCH] Fix Doxygen group comments

["Brian W. Fitzpatrick" <fi...@collab.net>]

On Jun 2, 2005, at 10:17 PM, Marcel Gosselin wrote:
> Improve Doxygen group usage by placing the "@{" just before the  
> first element of the
> group and by adding an "@name" group name.
>
> * subversion\include\svn_fs.h
> * subversion\include\svn_dav.h
> * subversion\include\svn_subst.h
> * subversion\include\svn_config.h
> * subversion\include\svn_client.h
> * subversion\include\svn_auth.h
>  Move the "@{" group tags and add "@name" to those groups.

Applied in r14951.

Thanks again!

-Fitz

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org