From e50b31bd406f51438513921b7daf0c950999f778 Mon Sep 17 00:00:00 2001 From: Ross Bencina Date: Sun, 25 Sep 2016 17:49:15 +1000 Subject: [PATCH] Update doxygen comments for WDM/KS to indicate that new APIs are available in 19.5.0 --- include/pa_win_wdmks.h | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/include/pa_win_wdmks.h b/include/pa_win_wdmks.h index 9a08c8f..3592962 100644 --- a/include/pa_win_wdmks.h +++ b/include/pa_win_wdmks.h @@ -53,14 +53,20 @@ extern "C" { #endif /* __cplusplus */ - /* Setup flags */ + /** Flags to indicate valid fields in PaWinWDMKSInfo. + @see PaWinWDMKSInfo + @version Available as of 19.5.0. + */ typedef enum PaWinWDMKSFlags { - /* Makes WDMKS use the supplied latency figures instead of relying on the frame size reported - by the WaveCyclic device. Use at own risk! */ + /** Makes WDMKS use the supplied latency figures instead of relying on the frame size reported + by the WaveCyclic device. Use at own risk! + */ paWinWDMKSOverrideFramesize = (1 << 0), - /* Makes WDMKS (output stream) use the given channelMask instead of the default */ + /** Makes WDMKS (output stream) use the given channelMask instead of the default. + @version Available as of 19.5.0. + */ paWinWDMKSUseGivenChannelMask = (1 << 1), } PaWinWDMKSFlags; @@ -69,11 +75,20 @@ extern "C" unsigned long size; /**< sizeof(PaWinWDMKSInfo) */ PaHostApiTypeId hostApiType; /**< paWDMKS */ unsigned long version; /**< 1 */ + + /** Flags indicate which fields are valid. + @see PaWinWDMKSFlags + @version Available as of 19.5.0. + */ unsigned long flags; - /* The number of packets to use for WaveCyclic devices, range is [2, 8]. Set to zero for default value of 2. */ + /** The number of packets to use for WaveCyclic devices, range is [2, 8]. Set to zero for default value of 2. */ unsigned noOfPackets; - /* If paWinWDMKSUseGivenChannelMask bit is set in flags, use this as channelMask instead of default */ + + /** If paWinWDMKSUseGivenChannelMask bit is set in flags, use this as channelMask instead of default. + @see PaWinWDMKSFlags + @version Available as of 19.5.0. + */ unsigned channelMask; } PaWinWDMKSInfo; -- 2.43.0