Re: [Doxygen-users] Confusion regarding void

[René S. <r.s...@gm...>]

void is not a return type.
And even if void would be a type - there is no sense in just copy the
type onto the \return doc.
\return should document the semantic and not the syntax. The syntax is
allready documented by the code.
So no return type (void function) -> no return semantic to document ->
no \return command
The same is true for parameter.


Am 17.04.2023 um 21:17 schrieb Pratyush Jayachandran:
> 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
>
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users