|
»
»
»
Extra information for a group member
|
View:
New views
7 Messages
—
Rating Filter:
Alert me
|
 |
Extra information for a group member
by Jesus Jimenez
::
Rate this Message:
Good morning to all,
I need to comment structure blocks like the example in which some of defines have extra information, but not all. If I use group naming it automatically set the main comment to each group element. But I would like to add extra information to "some" of them. Have anyone any idea about how can I do that? with kind regards, Jesus. Example: //@{ //! Main group information #define foo1 1 .... #define fook k //! extra information for the component foobar k .... //@} ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|||||||||||
|
|
Re: Extra information for a group member
by Greg Aldridge
::
Rate this Message:
This page (http://www.stack.nl/~dimitri/doxygen/docblocks.html#memberdoc)
in the Doxygen manual should answer your question. Greg. > -----Original Message----- > From: doxygen-users-bounces@... > [mailto:doxygen-users-bounces@...] On > Behalf Of Jesus Jimenez > Sent: 02 September 2008 08:28 > To: doxygen-users@... > Subject: [Doxygen-users] Extra information for a group member > > > Good morning to all, > I need to comment structure blocks > like the example in which some of defines have extra information, but > not all. If I use group naming it automatically set the > main comment > to each group element. But I would like to add extra information to > "some" of them. Have anyone any idea about how can I do that? > > with kind regards, > Jesus. > > Example: > > //@{ > //! Main group information > #define foo1 1 > .... > #define fook k //! extra information for the component foobar k > .... > //@} > > > -------------------------------------------------------------- > ----------- > This SF.Net email is sponsored by the Moblin Your Move > Developer's challenge > Build the coolest Linux based applications with Moblin SDK & > win great prizes > Grand prize is a trip for two to an Open Source event > anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > Doxygen-users mailing list > Doxygen-users@... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > **************************************************** Visit our website at <http://www.domino-printing.com/> **************************************************** This Email and any files transmitted with it are intended only for the person or entity to which it is addressed and may contain confidential and/or privileged material. Any reading, redistribution, disclosure or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you are not the intended recipient please contact the sender immediately and delete the material from your computer. E-mail may be susceptible to data corruption, interception, viruses and unauthorised amendment and Domino UK Limited does not accept liability for any such corruption, interception, viruses or amendment or their consequences. **************************************************** Domino UK Limited. Registered in England. Registered Number:1750201. Registered Office Address: Trafalgar Way, Bar Hill, Cambridge, CB23 8TU. ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|||||||||||
|
|
|
|||||||||||
|
|
|
|||||||||||
|
|
Re: Extra information for a group member
by Clemens Feige
::
Rate this Message:
Greg Aldridge:
> I guess as soon as you override the group description for one of the > group members, it will do it for all, except the first one which uses > the documentation block preceding it as if it was a standard. I'd > expect he trailing comment to replace the group description for that > one member, but not affect the whole group. > > Maybe you should consider raising a bug/feature request for this. What > others on the list think about this behaviour? Hi Jesus, Hi Greg! I have not tested myself. But if it is true what Greg describes then I too would plead for a bug report. A group description should be valid for all the group members, unless and only if there is an individual description for some members. All other members before and after those special member shall get the group description (and not the one from the last special member). Clemens ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|||||||||||
|
|
Re: Extra information for a group member
by Jesus Jimenez
::
Rate this Message:
Hi all,
I found the solution, its not a bug. The problem is that it was not well commented. Here is how should be: //@{ //!\name foobars1 //! foobars group comments #define foo1 1 ..... //! foon extra info #define foon n //@} or //@{ /*!\name foobars1 */ //! foobars group comments #define foo1 1 ..... //! foon extra info #define foon n //@} or //@{ /*!\name foobars1 \brief foobars group comments */ #define foo1 1 ..... //! foon extra info #define foon n //@} or ... (There are more solutions) ... Jesus. PD: Thanks to all for the help Clemens Feige wrote: > Greg Aldridge: > >> I guess as soon as you override the group description for one of the >> group members, it will do it for all, except the first one which uses >> the documentation block preceding it as if it was a standard. I'd >> expect he trailing comment to replace the group description for that >> one member, but not affect the whole group. >> > > > >> Maybe you should consider raising a bug/feature request for this. What >> others on the list think about this behaviour? >> > > Hi Jesus, Hi Greg! > > I have not tested myself. But if it is true what Greg describes then I > too would plead for a bug report. > > A group description should be valid for all the group members, unless > and only if there is an individual description for some members. All > other members before and after those special member shall get the group > description (and not the one from the last special member). > > Clemens > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > Doxygen-users mailing list > Doxygen-users@... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|||||||||||
|
|
Re: Extra information for a group member
by Douglas Wooster
::
Rate this Message:
Thanks for figuring this out, Jesus. And thank you even more, for reporting the solution back to us. I've been following the discussion, but haven't known enough about groups to be able to contribute to it. Best regards, Douglas Wooster
Hi all, I found the solution, its not a bug. The problem is that it was not well commented. Here is how should be: //@{ //!\name foobars1 //! foobars group comments #define foo1 1 ..... //! foon extra info #define foon n //@} or //@{ /*!\name foobars1 */ //! foobars group comments #define foo1 1 ..... //! foon extra info #define foon n //@} or //@{ /*!\name foobars1 \brief foobars group comments */ #define foo1 1 ..... //! foon extra info #define foon n //@} or ... (There are more solutions) ... Jesus. PD: Thanks to all for the help Clemens Feige wrote: > Greg Aldridge: > >> I guess as soon as you override the group description for one of the >> group members, it will do it for all, except the first one which uses >> the documentation block preceding it as if it was a standard. I'd >> expect he trailing comment to replace the group description for that >> one member, but not affect the whole group. >> > > > >> Maybe you should consider raising a bug/feature request for this. What >> others on the list think about this behaviour? >> > > Hi Jesus, Hi Greg! > > I have not tested myself. But if it is true what Greg describes then I > too would plead for a bug report. > > A group description should be valid for all the group members, unless > and only if there is an individual description for some members. All > other members before and after those special member shall get the group > description (and not the one from the last special member). > > Clemens > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > Doxygen-users mailing list > Doxygen-users@... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
| Free Forum Powered by Nabble | Forum Help |
