From 7d6950a7576a75d92b6274ac0bfd0391f3cd842b Mon Sep 17 00:00:00 2001 From: bjornroche Date: Sat, 9 Jul 2011 15:01:52 +0000 Subject: [PATCH] Fix for doxygen for pa_mac_core.h. Ticket #70. Patch from chris share modified slightly. --- include/pa_mac_core.h | 44 +++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/include/pa_mac_core.h b/include/pa_mac_core.h index 43321b6..f7a90f0 100644 --- a/include/pa_mac_core.h +++ b/include/pa_mac_core.h @@ -53,7 +53,7 @@ extern "C" { #endif -/* +/** * A pointer to a paMacCoreStreamInfo may be passed as * the hostApiSpecificStreamInfo in the PaStreamParameters struct * when opening a stream or querying the format. Use NULL, for the @@ -65,17 +65,17 @@ typedef struct unsigned long size; /**size of whole structure including this header */ PaHostApiTypeId hostApiType; /**host API for which this data is intended */ unsigned long version; /**structure version */ - unsigned long flags; /* flags to modify behaviour */ - SInt32 const * channelMap; /* Channel map for HAL channel mapping , if not needed, use NULL;*/ - unsigned long channelMapSize; /* Channel map size for HAL channel mapping , if not needed, use 0;*/ + unsigned long flags; /** flags to modify behaviour */ + SInt32 const * channelMap; /** Channel map for HAL channel mapping , if not needed, use NULL;*/ + unsigned long channelMapSize; /** Channel map size for HAL channel mapping , if not needed, use 0;*/ } PaMacCoreStreamInfo; -/* +/** * Functions */ -/* Use this function to initialize a paMacCoreStreamInfo struct +/** Use this function to initialize a paMacCoreStreamInfo struct * using the requested flags. Note that channel mapping is turned * off after a call to this function. * @param data The datastructure to initialize @@ -83,14 +83,14 @@ typedef struct */ void PaMacCore_SetupStreamInfo( PaMacCoreStreamInfo *data, unsigned long flags ); -/* call this after pa_SetupMacCoreStreamInfo to use channel mapping as described in notes.txt. +/** call this after pa_SetupMacCoreStreamInfo to use channel mapping as described in notes.txt. * @param data The stream info structure to assign a channel mapping to * @param channelMap The channel map array, as described in notes.txt. This array pointer will be used directly (ie the underlying data will not be copied), so the caller should not free the array until after the stream has been opened. * @param channelMapSize The size of the channel map array. */ void PaMacCore_SetupChannelMap( PaMacCoreStreamInfo *data, const SInt32 * const channelMap, unsigned long channelMapSize ); -/* +/** * Retrieve the AudioDeviceID of the input device assigned to an open stream * * @param s The stream to query. @@ -99,7 +99,7 @@ void PaMacCore_SetupChannelMap( PaMacCoreStreamInfo *data, const SInt32 * const */ AudioDeviceID PaMacCore_GetStreamInputDevice( PaStream* s ); -/* +/** * Retrieve the AudioDeviceID of the output device assigned to an open stream * * @param s The stream to query. @@ -108,7 +108,7 @@ AudioDeviceID PaMacCore_GetStreamInputDevice( PaStream* s ); */ AudioDeviceID PaMacCore_GetStreamOutputDevice( PaStream* s ); -/* +/** * Returns a statically allocated string with the device's name * for the given channel. NULL will be returned on failure. * @@ -124,28 +124,28 @@ AudioDeviceID PaMacCore_GetStreamOutputDevice( PaStream* s ); */ const char *PaMacCore_GetChannelName( int device, int channelIndex, bool input ); -/* +/** * Flags */ -/* +/** * The following flags alter the behaviour of PA on the mac platform. * they can be ORed together. These should work both for opening and * checking a device. */ -/* Allows PortAudio to change things like the device's frame size, +/** Allows PortAudio to change things like the device's frame size, * which allows for much lower latency, but might disrupt the device * if other programs are using it, even when you are just Querying * the device. */ #define paMacCoreChangeDeviceParameters (0x01) -/* In combination with the above flag, +/** In combination with the above flag, * causes the stream opening to fail, unless the exact sample rates * are supported by the device. */ #define paMacCoreFailIfConversionRequired (0x02) -/* These flags set the SR conversion quality, if required. The wierd ordering +/** These flags set the SR conversion quality, if required. The wierd ordering * allows Maximum Quality to be the default.*/ #define paMacCoreConversionQualityMin (0x0100) #define paMacCoreConversionQualityMedium (0x0200) @@ -153,26 +153,26 @@ const char *PaMacCore_GetChannelName( int device, int channelIndex, bool input ) #define paMacCoreConversionQualityHigh (0x0400) #define paMacCoreConversionQualityMax (0x0000) -/* +/** * Here are some "preset" combinations of flags (above) to get to some * common configurations. THIS IS OVERKILL, but if more flags are added * it won't be. */ -/*This is the default setting: do as much sample rate conversion as possible +/**This is the default setting: do as much sample rate conversion as possible * and as little mucking with the device as possible. */ #define paMacCorePlayNice (0x00) -/*This setting is tuned for pro audio apps. It allows SR conversion on input +/**This setting is tuned for pro audio apps. It allows SR conversion on input and output, but it tries to set the appropriate SR on the device.*/ #define paMacCorePro (0x01) -/*This is a setting to minimize CPU usage and still play nice.*/ +/**This is a setting to minimize CPU usage and still play nice.*/ #define paMacCoreMinimizeCPUButPlayNice (0x0100) -/*This is a setting to minimize CPU usage, even if that means interrupting the device. */ +/**This is a setting to minimize CPU usage, even if that means interrupting the device. */ #define paMacCoreMinimizeCPU (0x0101) #ifdef __cplusplus } -#endif /* __cplusplus */ +#endif /** __cplusplus */ -#endif /* PA_MAC_CORE_H */ +#endif /** PA_MAC_CORE_H */ -- 2.43.0