Fixing ApiAnalyzer errors. (#1794)

microsoft · Jan 24, 2017 · 4c153c4 · 4c153c4
1 parent aa8a8d4
commit 4c153c4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/Frameworks/AudioToolbox/AudioConverter.mm b/Frameworks/AudioToolbox/AudioConverter.mm
@@ -54,9 +54,9 @@ - (float)getSizeChangeMultiplier {
 @end
 
 /**
- @Status Caveat: AudioConverter supported only for conversions through AudioConverterConvertBuffer.
-                 Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
- @Notes
+ @Status Caveat
+ @Notes AudioConverter supported only for conversions through AudioConverterConvertBuffer. 
+        Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
 */
 OSStatus AudioConverterDispose(AudioConverterRef inAudioConverter) {
     RETURN_AUDIOERR_IF_FAILED_WITH_MSG(MFShutdown(), @"MFShutdown Failed");
@@ -98,9 +98,10 @@ OSStatus _setMFProperties(const AudioStreamBasicDescription* format, IMFMediaTyp
 }
 
 /**
-@Status Caveat: AudioConverter supported only for conversions through AudioConverterConvertBuffer.
-                Only Linear PCM formats are supported with 1 Frame per Packet and equal source & destination Channels per Frame.
-                Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
+@Status Caveat
+@Notes AudioConverter supported only for conversions through AudioConverterConvertBuffer.
+       Only Linear PCM formats are supported with 1 Frame per Packet and equal source & destination Channels per Frame.
+       Returns kAudioConverterErr_UnspecifiedError on failure and noErr (0) on success. Other return types not supported.
 */
 OSStatus AudioConverterNew(const AudioStreamBasicDescription* inSourceFormat,
                            const AudioStreamBasicDescription* inDestinationFormat,
@@ -212,9 +213,9 @@ OSStatus AudioConverterSetProperty(AudioConverterRef inAudioConverter,
 }
 
 /**
- @Status Caveat: Returns kAudioConverterErr_UnspecifiedError, kAudioConverterErr_InvalidInputSize or
-                 kAudioConverterErr_InvalidOutputSize on failure and noErr (0) on success. Other return types not supported.
- @Notes
+ @Status Caveat
+ @Notes Returns kAudioConverterErr_UnspecifiedError, kAudioConverterErr_InvalidInputSize or
+        kAudioConverterErr_InvalidOutputSize on failure and noErr (0) on success. Other return types not supported.
 */
 OSStatus AudioConverterConvertBuffer(
     AudioConverterRef inAudioConverter, UInt32 inInputDataSize, const void* inInputData, UInt32* ioOutputDataSize, void* outOutputData) {

diff --git a/include/AudioToolbox/AudioConverterInternal.h b/include/AudioToolbox/AudioConverterInternal.h
@@ -30,6 +30,9 @@
 #include <wmcodecdsp.h>
 #include <COMIncludes_End.h>
 
+#import <Foundation/NSObject.h>
+#import <CoreAudio/CoreAudioTypes.h>
+
 using namespace Microsoft::WRL;
 using namespace Microsoft::WRL::Wrappers;