Re: [Doxygen-users] (no subject)
Brought to you by:
dimitri
|
From: Dimitri v. H. <di...@st...> - 2004-07-09 13:28:59
|
On Fri, Jul 09, 2004 at 11:43:29AM +0100, Irene Higson wrote:
> Hi,
>
> I am trying to group a set of #define statements, due to a general
> comment for them. In addition these statements also have individual
> comments. Does this cause problems?
> I am asking because the specific comments appear in the header for the
> statements in the html documentation, as well as where they are supposed
> to be, and the general comment does not appear anywhere.
>
> To clarify:
> /*@{*/
> /**General comment, applies to all following #define statements*/
> #define xxx /**Specific comment1*/
> #define yyy /**Specific comment2*/
> #define etc. /**Specific commentN*/
> /*@}*/
>
> I am also having problems grouping functions in different header files.
> I have tried using @defgroup in one and @addtogroup in the other header
> file, also tried @addtogroup in both, as well as @defgroup in one and
> @ingroup in the other.
> The only output I get is for the header file in which I have used
> @defgroup, even if I change this to @addtogroup.
> What should I use to manage?
Try this:
/** @name Group Header
* General comment, applies to all following #define statements*/
* @{
*/
#define xxx /**< Specific comment1 */
#define yyy /**< Specific comment2 */
#define etc. /**< Specific commentN */
/* @} */
Regards,
Dimitri
|