Documenting a typedef gives "not documented" warning.
roger via Doxygen-users <[email protected]> Sat, 9 Sep 2023 10:26:46 +0100
| Newsgroups | gmane.text.doxygen.general |
|---|---|
| Message-ID | <[email protected]> |
This is a multi-part message in MIME format.
--===============6052104903329212697==
Content-Type: multipart/alternative;
boundary="------------S4Cb2J2pUi6txwIzzY5xR0N5"
Content-Language: en-GB
This is a multi-part message in MIME format.
--------------S4Cb2J2pUi6txwIzzY5xR0N5
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
I am going round in circles on this.
I have a very simple typedef that looks like this.
/** @structst_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.
*/
typedefstructst_melody{
charnote_on;
charchannel;
charnote;
intduration;
} 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
--------------S4Cb2J2pUi6txwIzzY5xR0N5
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
<html>
<head>
<meta http-equiv=3D"content-type" content=3D"text/html; charset=3DUTF=
-8">
</head>
<body>
I am going round in circles on this.<br>
<br>
I have a very simple typedef that looks like this.<br>
<br>
<div style=3D"color: #cccccc;background-color: #1f1f1f;font-family: '=
Droid Sans Mono', 'monospace', monospace;font-weight: normal;font-size: 1=
4px;line-height: 19px;white-space: pre;"><div><span style=3D"color: #6a99=
55;">/** </span><span style=3D"color: #569cd6;">@struct</span><span style=
=3D"color: #6a9955;"> st_melody</span></div><div><span style=3D"color: #6=
a9955;"> * </span></div><div><span style=3D"color: #6a9955;"> * @var melo=
dy_t::note_on</span></div><div><span style=3D"color: #6a9955;"> * Is note=
on (0 =3D OFF 1 =3D ON).</span></div><div><span style=3D"color: #6a9955=
;"> * @var melody_t::channel</span></div><div><span style=3D"color: #6a99=
55;"> * Midi channel number.</span></div><div><span style=3D"color: #6a99=
55;"> * @var melody_t::note</span></div><div><span style=3D"color: #6a995=
5;"> * Midi note number.</span></div><div><span style=3D"color: #6a9955;"=
> * @var melody_t::duration</span></div><div><span style=3D"color: #6a995=
5;"> * Time to wait (ms) until next note action.</span></div><div><span s=
tyle=3D"color: #6a9955;">*/</span></div><div><span style=3D"color: #569cd=
6;">typedef</span><span style=3D"color: #cccccc;"> </span><span style=3D"=
color: #569cd6;">struct</span><span style=3D"color: #cccccc;"> </span><sp=
an style=3D"color: #4ec9b0;">st_melody</span><span style=3D"color: #ccccc=
c;"> {</span></div><div><span style=3D"color: #cccccc;"> </span><span =
style=3D"color: #569cd6;">char</span><span style=3D"color: #cccccc;"> </s=
pan><span style=3D"color: #9cdcfe;">note_on</span><span style=3D"color: #=
cccccc;">;</span></div><div><span style=3D"color: #cccccc;"> </span><s=
pan style=3D"color: #569cd6;">char</span><span style=3D"color: #cccccc;">=
</span><span style=3D"color: #9cdcfe;">channel</span><span style=3D"colo=
r: #cccccc;">;</span></div><div><span style=3D"color: #cccccc;"> </spa=
n><span style=3D"color: #569cd6;">char</span><span style=3D"color: #ccccc=
c;"> </span><span style=3D"color: #9cdcfe;">note</span><span style=3D"col=
or: #cccccc;">;</span></div><div><span style=3D"color: #cccccc;"> </sp=
an><span style=3D"color: #569cd6;">int</span><span style=3D"color: #ccccc=
c;"> </span><span style=3D"color: #9cdcfe;">duration</span><span style=3D=
"color: #cccccc;">;</span></div><div><span style=3D"color: #cccccc;">} </=
span><span style=3D"color: #4ec9b0;">melody_t</span><span style=3D"color:=
#cccccc;">;</span></div>
</div>
<pre></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>
--------------S4Cb2J2pUi6txwIzzY5xR0N5--
--===============6052104903329212697==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
--===============6052104903329212697==
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
--===============6052104903329212697==--