doc cleanup

This commit is contained in:
Andrew Kelley 2015-08-27 23:37:29 -07:00
parent ff73c08667
commit 0f508fcf19

View file

@ -100,9 +100,9 @@ enum SoundIoError {
/// Specifies where a channel is physically located. /// Specifies where a channel is physically located.
enum SoundIoChannelId { enum SoundIoChannelId {
// These channel ids are more commonly supported.
SoundIoChannelIdInvalid, SoundIoChannelIdInvalid,
SoundIoChannelIdFrontLeft,
SoundIoChannelIdFrontLeft, ///< First of the more commonly supported ids.
SoundIoChannelIdFrontRight, SoundIoChannelIdFrontRight,
SoundIoChannelIdFrontCenter, SoundIoChannelIdFrontCenter,
SoundIoChannelIdLfe, SoundIoChannelIdLfe,
@ -119,10 +119,9 @@ enum SoundIoChannelId {
SoundIoChannelIdTopFrontRight, SoundIoChannelIdTopFrontRight,
SoundIoChannelIdTopBackLeft, SoundIoChannelIdTopBackLeft,
SoundIoChannelIdTopBackCenter, SoundIoChannelIdTopBackCenter,
SoundIoChannelIdTopBackRight, SoundIoChannelIdTopBackRight, ///< Last of the more commonly supported ids.
// These channel ids are less commonly supported. SoundIoChannelIdBackLeftCenter, ///< First of the less commonly supported ids.
SoundIoChannelIdBackLeftCenter,
SoundIoChannelIdBackRightCenter, SoundIoChannelIdBackRightCenter,
SoundIoChannelIdFrontLeftWide, SoundIoChannelIdFrontLeftWide,
SoundIoChannelIdFrontRightWide, SoundIoChannelIdFrontRightWide,
@ -140,29 +139,28 @@ enum SoundIoChannelId {
SoundIoChannelIdBottomLeftCenter, SoundIoChannelIdBottomLeftCenter,
SoundIoChannelIdBottomRightCenter, SoundIoChannelIdBottomRightCenter,
// Mid/side recording /// Mid/side recording
SoundIoChannelIdMsMid, SoundIoChannelIdMsMid,
SoundIoChannelIdMsSide, SoundIoChannelIdMsSide,
// first order ambisonic channels /// first order ambisonic channels
SoundIoChannelIdAmbisonicW, SoundIoChannelIdAmbisonicW,
SoundIoChannelIdAmbisonicX, SoundIoChannelIdAmbisonicX,
SoundIoChannelIdAmbisonicY, SoundIoChannelIdAmbisonicY,
SoundIoChannelIdAmbisonicZ, SoundIoChannelIdAmbisonicZ,
// X-Y Recording /// X-Y Recording
SoundIoChannelIdXyX, SoundIoChannelIdXyX,
SoundIoChannelIdXyY, SoundIoChannelIdXyY,
// Other SoundIoChannelIdHeadphonesLeft, ///< First of the "other" channel ids
SoundIoChannelIdHeadphonesLeft,
SoundIoChannelIdHeadphonesRight, SoundIoChannelIdHeadphonesRight,
SoundIoChannelIdClickTrack, SoundIoChannelIdClickTrack,
SoundIoChannelIdForeignLanguage, SoundIoChannelIdForeignLanguage,
SoundIoChannelIdHearingImpaired, SoundIoChannelIdHearingImpaired,
SoundIoChannelIdNarration, SoundIoChannelIdNarration,
SoundIoChannelIdHaptic, SoundIoChannelIdHaptic,
SoundIoChannelIdDialogCentricMix, SoundIoChannelIdDialogCentricMix, ///< Last of the "other" channel ids
SoundIoChannelIdAux, SoundIoChannelIdAux,
SoundIoChannelIdAux0, SoundIoChannelIdAux0,