Audio

Timestamp:

Jan 3, 2017 10:16:46 AM (8 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

112558

Message:

Devices/Audio: doxygen fixes (s/@true/false / @c true/false/)

Location:

trunk/src/VBox/Devices/Audio

Files:

trunk/src/VBox/Devices/Audio/AudioMixBuffer.cpp

-              r65016
+              r65056
 /**
  * Returns @true if there are any audio samples available for processing,
  * @false if not.
+ *
  * @return  bool                    @true if there are any audio samples available for processing, @false if not.
+ * Returns @c true if there are any audio samples available for processing,
+ * @c false if not.
+ *
+ * @return  bool                    @c true if there are any audio samples available for processing, @c false if not.
  * @param   pMixBuf                 Mixing buffer to return value for.
  */

-              r65017
+              r65056
  * Returns whether a mixer stream currently is active (playing/recording) or not.
+ *
  * @returns @true if playing/recording, @false if not.
+ * @returns @c true if playing/recording, @c false if not.
  * @param   pMixStream          Mixer stream to return status for.
  */
 …
  * Returns whether a mixer stream is valid (e.g. initialized and in a working state) or not.
+ *
  * @returns @true if valid, @false if not.
+ * @returns @c true if valid, @c false if not.
  * @param   pMixStream          Mixer stream to return status for.
  */

-              r65035
+              r65056
+ *
  * @return  IPRT status code.
  * @return  bool                @true for signed bits, @false for unsigned.
+ * @return  bool                @c true for signed bits, @c false for unsigned.
  * @param   enmFmt              Audio format to retrieve value for.
  */
 …
  * stream configuration.
+ *
  * @returns @true if equal, @false if not.
+ * @returns @c true if equal, @c false if not.
  * @param   pProps              PCM properties to compare.
  * @param   pCfg                Stream configuration to compare.
 …
  * Checks whether two given PCM properties are equal.
+ *
  * @returns @true if equal, @false if not.
+ * @returns @c true if equal, @c false if not.
  * @param   pProps1             First properties to compare.
  * @param   pProps2             Second properties to compare.
 …
  * Checks whether a given stream configuration is valid or not.
+ *
  * Returns @true if configuration is valid, @false if not.
+ * Returns @c true if configuration is valid, @c false if not.
  * @param   pCfg                Stream configuration to check.
  */

Note: See TracChangeset for help on using the changeset viewer.