search

PortAudio / portaudio

PortAudio is a cross-platform, open-source C language library for real-time audio input and output.
Other
1.43k stars 295 forks source link

Ensure every source file has doxygen @ingroup and @brief description #12

Open PortAudio-admin opened 18 years ago

PortAudio-admin commented 18 years ago

Issue created by @RossBencina

[Trac: Originally assigned to none]

There is now a "guide to the source code" page in the doxygen documentation: http://www.portaudio.com/docs/v19-doxydocs/srcguide.html

This groups source files into different categories and lists them along with their brief documentation. This is useful (for example) to see a compact list of all test files and what each one does.

The lists are not completely up to date (some files are not listed properly, this needs to be checked and corrected). If you are responsible for a particular file and can't find it in one of the lists it would be a good idea to check that its doxygen comment block is in order.

use @ingroup to specify the group membership of a file. see doc/src/srcguide.dox for the current list of groups a file can belong to

See also ticket #71 it is closely related and has more info.

PortAudio-admin commented 18 years ago

Comment by @RossBencina

There is now a script at: doc/utils/checkfiledocs.py which soes some simple checks on all source files for minimal doxygen documentation

PortAudio-admin commented 13 years ago

Comment by @RossBencina

In some cases files will already have a description that isn't marked up correctly. in other cases you may need to ask on the list or do some other research to work out what the description should be.

PortAudio-admin commented 12 years ago

Comment by @RossBencina

TRAC migration: propagating ticket status from TRAC