Re: [Doxygen-users] one document paragraph for N types set by typedef struct?

[Albert <alb...@gm...>]

David,

Please have a look at DISTRIBUTE_GROUP_DOC set to yes and the grouping
possibilities by using @{ and @}
The following looks like to work for me:
/// @{
/** Description blah blah
*/
typedef struct names {
     SomeStructName    field;                //!< Description of field
} name1, name2, name3, namen;
/// @}


Note: that I had to make a named struct of it as well otherwise name1 would
be used as type name and not as variable.

Albert


On Sat, Nov 23, 2013 at 12:37 AM, mathog <ma...@ca...> wrote:

> An include file from a C program looks like this:
>
> /** Description blah blah
> */
> typedef struct {
>      SomeStructName    field;                //!< Description of field
> } name1, name2, name3, ... namen;
>
> When doxygen processes this it hooks the documentation to name1 and
> leaves
> name2 -> namen flapping in the breeze.  It issues "undocumented"
> warnings about
> name2-> namen.
>
> Making N copies of this and editing the list down to one name for each
> would resolve the Doxygen issue, but it is a lot of work.  Is there some
> magic switch to tell Doxygen that "name2 is like name1", or better yet,
> "name2->namen are like name1"?
>
> Thanks,
>
> David Mathog
> ma...@ca...
> Manager, Sequence Analysis Facility, Biology Division, Caltech
>
>
> ------------------------------------------------------------------------------
> Shape the Mobile Experience: Free Subscription
> Software experts and developers: Be at the forefront of tech innovation.
> Intel(R) Software Adrenaline delivers strategic insight and game-changing
> conversations that shape the rapidly evolving mobile landscape. Sign up
> now.
> http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>