[Doxygen-develop] documenting c-struct members

[Michael D. <mi...@na...>]

Hi everybody,

here's a thread that I started on doxygen-users. Maybe I get an answer 
to my questions below on doxygen-develop, hopefully.

	Micha.

On Monday 22 September 2003 23:01, Dimitri van Heesch wrote:
> On Mon, Sep 22, 2003 at 09:19:18AM +0200, Michael Daum wrote:
> > is it possible to document c-struct members at another place? 
> Probably the following:
>
> struct c_struct
> {
>   int field1;
>   int field2;
> };
>
> /*! \struct c_struct
>     My struct
>  */
>
> /*! \var c_struct::field1
>     First field
>  */
>
> /*! \var c_struct::field2
>     Second field
>  */
>

Ah. 

But I don't get exactly what I wanted. The c_struct is part of a group 
(of related structures). The \var docu then goes into the group docu
(section Variables) and is marked 'inherited'. Actually I expected the 
c_struct::field1 to be on the page documenting the c_struct. 
Putting together all variables of all c-structures of a group is not a very good idea.

Another thing is that each \var needs a document block of its own. So here's 
one for the wishlist: 
  (1) make consecutive s work in one document block:

    /** \var c_struct::field1
     *        First Field.
     * \var c_struct::field2
     *        Second Field.
     */

  (2) make c_struct:: in c_struct::field1 dispensable in the document block belonging
    to that structure

    /** A structure description.
     * \var field1
     *       First Field.
     * \var field2
     *       Second Field
     */
    struct c_struct {
        field1;
        field2;
    };

Difficult?

Micha.

-- 
-- Michael Daum
-- Natural Language Systems
-- Faculty of Informatics
---University of Hamburg
-- http://nats-www.informatik.uni-hamburg.de/~micha