Re: [Doxygen-users] Confusion regarding void

[Robert H. <he...@de...>]

At Mon, 17 Apr 2023 12:17:32 -0700 Pratyush Jayachandran <pra...@gm...> 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
> 

*I* usually just leave the @param out if there are no parameters.  For 
@return for a void function, I would say "@returns nothing"

Typically something like this:
 
/** This is a function returning void.                                         
 * @param a First param                                                        
 * @param b Second param                                                       
 * @returns nothing.                                                           
 */                                                                            
void foo(int a, int b);                                                        
 
/** This is a function with no parameters.                                     
 * @return The uptime.                                                         
 */                                                                            
long long int uptime();                                                        
 
/** This is a functions with no parameters returning void.                     
 * @returns nothing.                                                           
 */                                                                            
void nothing();                                                                
 
                                                                               
 


> Omitting them will result in the document showing just blank.
> 
> Is it left on the user to decide? What is the industry standard?

Different people have different "standards" for documentation.

> 
> Regards,
> Pratyush
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
> 

-- 
Robert Heller             -- Cell: 413-658-7953 GV: 978-633-5364
Deepwoods Software        -- Custom Software Services
http://www.deepsoft.com/  -- Linux Administration Services
he...@de...       -- Webhosting Services