Confusion regarding void
Pratyush Jayachandran <[email protected]> Mon, 17 Apr 2023 12:17:32 -0700
| Newsgroups | gmane.text.doxygen.general |
|---|---|
| Message-ID | <CAJVNSRiMLRCkpQzuwB_6YSYguoa4b__HcEgQVUkPxKcGFcHRgg@mail.gmail.com> |
--===============1990366443316998944== Content-Type: multipart/alternative; boundary="0000000000009c09e305f98d0bdc" --0000000000009c09e305f98d0bdc Content-Type: text/plain; charset="UTF-8" I'm documenting a project written in C. I couldn't find the rules for documenting functions that return void and/or have no parameters. By extension of other rules, should it be @return void and @param void Omitting them will result in the document showing just blank. Is it left on the user to decide? What is the industry standard? Regards, Pratyush --0000000000009c09e305f98d0bdc Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"auto">I'm documenting a project written in C.<div dir=3D"au= to"><br></div><div dir=3D"auto">I couldn't find the rules for documenti= ng functions that return void and/or have no parameters.</div><div dir=3D"a= uto"><br></div><div dir=3D"auto">By extension of other rules, should it be<= /div><div dir=3D"auto">@return void</div><div dir=3D"auto">and</div><div di= r=3D"auto">@param void</div><div dir=3D"auto"><br></div><div dir=3D"auto">O= mitting them will result in the document showing just blank.</div><div dir= =3D"auto"><br></div><div dir=3D"auto">Is it left on the user to decide? Wha= t is the industry standard?</div><div dir=3D"auto"><br></div><div dir=3D"au= to">Regards,</div><div dir=3D"auto">Pratyush=C2=A0</div><div dir=3D"auto"><= br></div></div> --0000000000009c09e305f98d0bdc-- --===============1990366443316998944== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline --===============1990366443316998944== 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 --===============1990366443316998944==--