Change over Doxygen \note documentation to \pre where applicable.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / Audio.h

diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index b76abf6..73c2934 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -145,8 +145,8 @@
                        /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
                         *  OUT endpoint ready for reading.
                         *
-                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
-                        *        the call will fail.
+                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *       the call will fail.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *
@@ -166,8 +166,8 @@
                        /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
                         *  the streaming IN endpoint ready for writing.
                         *
-                        *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
-                        *        the call will fail.
+                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *       the call will fail.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *
@@ -186,8 +186,8 @@
 
                        /** Reads the next 8-bit audio sample from the current audio interface.
                         *
-                        *  \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
-                        *        ensure the correct endpoint is selected and ready for data.
+                        *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
+                        *       ensure the correct endpoint is selected and ready for data.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *
@@ -211,8 +211,8 @@
 
                        /** Reads the next 16-bit audio sample from the current audio interface.
                         *
-                        *  \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
-                        *        that the correct endpoint is selected and ready for data.
+                        *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
+                        *       that the correct endpoint is selected and ready for data.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *
@@ -236,8 +236,8 @@
 
                        /** Reads the next 24-bit audio sample from the current audio interface.
                         *
-                        *  \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
-                        *        that the correct endpoint is selected and ready for data.
+                        *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
+                        *       that the correct endpoint is selected and ready for data.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *
@@ -261,8 +261,8 @@
 
                        /** Writes the next 8-bit audio sample to the current audio interface.
                         *
-                        *  \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
-                        *        ensure that the correct endpoint is selected and ready for data.
+                        *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
+                        *       ensure that the correct endpoint is selected and ready for data.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *  \param[in] Sample  Signed 8-bit audio sample
@@ -280,8 +280,8 @@
 
                        /** Writes the next 16-bit audio sample to the current audio interface.
                         *
-                        *  \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
-                        *        ensure that the correct endpoint is selected and ready for data.
+                        *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
+                        *       ensure that the correct endpoint is selected and ready for data.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *  \param[in] Sample  Signed 16-bit audio sample
@@ -299,8 +299,8 @@
 
                        /** Writes the next 24-bit audio sample to the current audio interface.
                         *
-                        *  \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
-                        *        ensure that the correct endpoint is selected and ready for data.
+                        *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
+                        *       ensure that the correct endpoint is selected and ready for data.
                         *
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
                         *  \param[in] Sample  Signed 24-bit audio sample