Documenting a typedef gives "not documented" warning.

roger via Doxygen-users <[email protected]> Sat, 9 Sep 2023 15:44:29 +0100
Newsgroups	gmane.text.doxygen.general
Message-ID	<[email protected]>
This is a multi-part message in MIME format.
--===============1938107218894442593==
Content-Type: multipart/alternative;
 boundary="------------q67fHAY8K8OR4y2tVfcOkNS3"
Content-Language: en-GB

This is a multi-part message in MIME format.
--------------q67fHAY8K8OR4y2tVfcOkNS3
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit

Apologies my previous post should have looked like this

I am going round in circles on this.

I have a very simple typedef that looks like this.

/** @struct st_melody

  *

  * @var melody_t::note_on

  * Is note on (0 = OFF  1 = ON).

  * @var melody_t::channel

  * Midi channel number.

  * @var melody_t::note

  * Midi note number.

  * @var melody_t::duration

  * Time to wait (ms) until next note action.

*/

typedef struct st_melody {

     char note_on;

     char channel;

     char note;

     int duration;

} melody_t;


I have tried this with both "@struct st_melody" and "@struct melody_t" 
and various other combination of @struct and @typedef. I always get this 
warning.

warning: Compound st_melody is not documented.

What am I doing wrong?

I am using doxygen 1.9.1.

Any help gratefully received.

Roger




--------------q67fHAY8K8OR4y2tVfcOkNS3
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: 8bit

<html>
  <head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  </head>
  <body>
    Apologies my previous post should have looked like this <br>
    <br>
    I am going round in circles on this.<br>
    <br>
    I have a very simple typedef that looks like this.<br>
    <br>
    <pre>/** @struct st_melody</pre>
    <pre> * </pre>
    <pre> * @var melody_t::note_on</pre>
    <pre> * Is note on (0 = OFF  1 = ON).</pre>
    <pre> * @var melody_t::channel</pre>
    <pre> * Midi channel number.</pre>
    <pre> * @var melody_t::note</pre>
    <pre> * Midi note number.</pre>
    <pre> * @var melody_t::duration</pre>
    <pre> * Time to wait (ms) until next note action.</pre>
    <pre>*/</pre>
    <pre>typedef struct st_melody {</pre>
    <pre>    char note_on;</pre>
    <pre>    char channel;</pre>
    <pre>    char note;</pre>
    <pre>    int duration;</pre>
    <pre>} melody_t;</pre>
    <br>
    I have tried this with both "@struct st_melody" and "@struct
    melody_t" and various other combination of @struct and @typedef. I
    always get this warning.<br>
    <br>
    warning: Compound st_melody is not documented.<br>
    <br>
    What am I doing wrong?<br>
    <br>
    I am using doxygen 1.9.1.<br>
    <br>
    Any help gratefully received.<br>
    <br>
    Roger<br>
    <br>
    <br>
    <br>
    <br>
  </body>
</html>

--------------q67fHAY8K8OR4y2tVfcOkNS3--


--===============1938107218894442593==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline


--===============1938107218894442593==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users

--===============1938107218894442593==--