[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    Re: [Doxygen-users] How to document a struct/class defined inside a macro call?
From:       Jakob van Bethlehem <J.S.van.Bethlehem () astro ! rug ! nl>
Date:       2012-09-17 7:00:30
Message-ID: 28C4E174-0DCC-47C6-810B-98ED0930B0E6 () astro ! rug ! nl
[Download RAW message or body]

Hej Marcio,

Maybe you can use the mechanism with '\class', e.g.:
/** \class A
  * Documentation of A
*/
PACKED(struct A {
 /// documentation for x
 int x;
});

Just a thought.

Greetsz, Jakob

On 1 sep. 2012, at 15:27, Márcio Faustino <marciombfaustino@gmail.com> wrote:

> Hi,
> 
> I have a `PACKED` macro [1], that receives a struct definition [2] and
> returns it with a compiler annotation to make it packed. For example:
> 
> /**
> * ...
> */
> PACKED(struct A {
>    /**
>     * ...
>     */
>    int x;
> });
> 
> I have tried several Doxygen options to include that documentation,
> but I've had no success so far. Closest I've come up with is this:
> 
> ENABLE_PREPROCESSING = YES
> PREDEFINED = PACKED(type)=type
> MACRO_EXPANSION = YES
> 
> But that messes up the struct and members' documentation (confirmed
> via `doxygen -d Preprocessor`).
> 
> Ideas?
> 
> [1] https://github.com/marciof/Eon/blob/master/library/util.h#L207
> [2] https://github.com/marciof/Eon/blob/master/core/architecture/x86/multiboot/Boot_Device.h#L21
> 
> Thanks,
> -- 
> Márcio Faustino
> 
> ------------------------------------------------------------------------------
> Live Security Virtual Conference
> Exclusive live event will cover all the ways today's security and 
> threat landscape has changed and how IT managers can respond. Discussions 
> will include endpoint security, mobile security and the latest in malware 
> threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]