Ticket #71 (new defect)
missing minimal doxygen documentation in some implementation files
| Reported by: | rossb | Owned by: | everyone |
|---|---|---|---|
| Priority: | minor | Milestone: | V19-RC1 |
| Component: | documentation | Version: | 2.0 |
| Keywords: | Cc: |
Description
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.
portaudio\src\common\pa_debugprint.h :
! no doxygen @brief tag
portaudio\src\common\pa_memorybarrier.h :
! no doxygen @brief tag
portaudio\src\common\pa_ringbuffer.c :
! no doxygen @brief tag
portaudio\src\common\pa_ringbuffer.h :
! no doxygen @brief tag
portaudio\src\hostapi\alsa\pa_linux_alsa.c :
! no doxygen @brief tag
portaudio\src\hostapi\asio\iasiothiscallresolver.cpp :
! no doxygen /** block ! no doxygen @file tag ! no doxygen @brief tag ! no doxygen @ingroup tag
portaudio\src\hostapi\asio\iasiothiscallresolver.h :
! no doxygen /** block ! no doxygen @file tag ! no doxygen @brief tag ! no doxygen @ingroup tag
portaudio\src\hostapi\asio\pa_asio.cpp :
! no doxygen @brief tag
portaudio\src\hostapi\coreaudio\pa_mac_core_blocking.c :
! no doxygen @brief tag
portaudio\src\hostapi\coreaudio\pa_mac_core_blocking.h :
! no doxygen @brief tag
portaudio\src\hostapi\coreaudio\pa_mac_core_utilities.c :
! no doxygen @brief tag
portaudio\src\hostapi\coreaudio\pa_mac_core_utilities.h :
! no doxygen @brief tag
portaudio\src\hostapi\dsound\pa_win_ds.c :
! no doxygen @brief tag
portaudio\src\hostapi\dsound\pa_win_ds_dynlink.c :
! no doxygen @brief tag
portaudio\src\hostapi\dsound\pa_win_ds_dynlink.h :
! no doxygen @brief tag
portaudio\src\hostapi\jack\pa_jack.c :
! no doxygen @brief tag
portaudio\src\hostapi\oss\pa_unix_oss.c :
! no doxygen @brief tag
portaudio\src\os\mac_osx\pa_mac_hostapis.c :
! no doxygen @brief tag
portaudio\src\os\unix\pa_unix_hostapis.c :
! no doxygen @brief tag
portaudio\src\os\unix\pa_unix_util.c :
! no doxygen @brief tag
portaudio\src\os\unix\pa_unix_util.h :
! no doxygen @brief tag
portaudio\src\os\win\pa_win_waveformat.c :
! no doxygen /** block ! no doxygen @file tag ! no doxygen @brief tag ! no doxygen @ingroup tag
portaudio\src\os\win\pa_win_wdmks_utils.c :
! no doxygen /** block ! no doxygen @file tag ! no doxygen @brief tag ! no doxygen @ingroup tag
portaudio\src\os\win\pa_win_wdmks_utils.h :
! no doxygen @ingroup tag
portaudio\src\os\win\pa_x86_plain_converters.c :
! no doxygen @brief tag
portaudio\test\patest_dsound_surround.c :
! no doxygen @file tag ! no doxygen @brief tag ! no doxygen @ingroup tag
portaudio\test\patest_wmme_surround.c :
! no doxygen @file tag ! no doxygen @brief tag ! no doxygen @ingroup tag
portaudio\test\patest_write_stop.c :
! no doxygen @ingroup tag
