At Mon, 17 Apr 2023 22:00:21 +0200 Ren?_Staffen wrote:
>
> 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.
>
At Mon, 17 Apr 2023 12:17:32 -0700 Pratyush Jayachandran
wrote:
>
> 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
>
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 ->
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
