Re: [AD] Another documentation clarification

[Eric Botcazou <ebotcazou@xxxxxxxxxx>]

> Yknow what would be nice is if every function that returned something(
> all non-void ) were documented in a standard way. Something like:
>
> int install_sound(int digi, int midi, const char *cfg_path);
> return: 0 if sound was installed successfully, -1 on failure.
> description:  Initialises the sound module. You should etc...

We have that already in the 4.1.x series, it's the

@retval

marker.

> I realize this would be alot of work, but I dont mind doing if it no one
> is opposed to the idea

Grzegorz has already started to add @retval markers to the docs.  I'd advise 
against doing so en masse, because this would be boring and error-prone.  
Instead, this could be done incrementally for groups of functions.

-- 
Eric Botcazou