Description
Issue created by @RossBencina
[Trac: Originally assigned to none]
running the portaudio/doc/utils/checkfiledocs.py reports numerous missing doxygen tags. The most significant ones are listed below. The brief tags and ingroup tags are important because they significantly assist in navigating the doxygen generated documentation.
See also ticket #12 it is closely related and has more info.
c:\PortAudio\pa_trunk\doc\utils>python checkfiledocs.py
c:\PortAudio\pa_trunk\src\common\pa_debugprint.h :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\common\pa_memorybarrier.h :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\common\pa_ringbuffer.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\common\pa_svnrevision.h :
! no doxygen /** block
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\hostapi\alsa\pa_linux_alsa.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\asio\iasiothiscallresolver.cpp :
! no doxygen /** block
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\hostapi\asio\iasiothiscallresolver.h :
! no doxygen /** block
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\hostapi\asio\pa_asio.cpp :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\coreaudio\pa_mac_core_blocking.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\coreaudio\pa_mac_core_blocking.h :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\coreaudio\pa_mac_core_old.c :
! no doxygen /** block
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\hostapi\coreaudio\pa_mac_core_utilities.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\coreaudio\pa_mac_core_utilities.h :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\dsound\pa_win_ds.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\dsound\pa_win_ds_dynlink.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\dsound\pa_win_ds_dynlink.h :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\jack\pa_jack.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\oss\pa_unix_oss.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\hostapi\oss\recplay.c :
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\os\unix\pa_unix_hostapis.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\os\unix\pa_unix_util.c :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\os\unix\pa_unix_util.h :
! no doxygen @brief tag
c:\PortAudio\pa_trunk\src\os\win\pa_win_waveformat.c :
! no doxygen /** block
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\os\win\pa_win_wdmks_utils.c :
! no doxygen /** block
! no doxygen @file tag
! no doxygen @brief tag
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\os\win\pa_win_wdmks_utils.h :
! no doxygen @InGroup tag
c:\PortAudio\pa_trunk\src\os\win\pa_x86_plain_converters.c :
! no doxygen @brief tag