Changeset 96323 in vbox for trunk/src/VBox/Main

Timestamp:

Aug 19, 2022 7:48:05 AM (2 years ago)

Author:

vboxsync

Message:

Recording/Main: Docs nits (use @c instead of \c).

Location:

trunk/src/VBox/Main

Files:

• src-client/Recording.cpp (modified) (1 diff)
• src-client/RecordingCodec.cpp (modified) (1 diff)
• src-client/RecordingStream.cpp (modified) (3 diffs)
• xml/Settings.cpp (modified) (3 diffs)

trunk/src/VBox/Main/src-client/Recording.cpp

@@ -682 +682 @@
  * recording streams or not.
  *
- * @returns \c true if at least one recording stream has this feature enabled, or \c false if
+ * @returns @c true if at least one recording stream has this feature enabled, or @c false if
  *          no recording stream has this feature enabled.
  * @param   enmFeature          Recording feature to check for.

trunk/src/VBox/Main/src-client/RecordingCodec.cpp

@@ -854 +854 @@
  * Returns whether the codec has been initialized or not.
  *
- * @returns \c true if initialized, or \c false if not.
+ * @returns @c true if initialized, or @c false if not.
  * @param   pCodec              Codec to return initialization status for.
  */

trunk/src/VBox/Main/src-client/RecordingStream.cpp

@@ -175 +175 @@
  * Checks if a specified limit for a recording stream has been reached, internal version.
  *
- * @returns \c true if any limit has been reached, \c false if not.
+ * @returns @c true if any limit has been reached, @c false if not.
  * @param   msTimestamp         Timestamp (PTS, in ms) to check for.
  */
@@ -261 +261 @@
  * Checks if a specified limit for a recording stream has been reached.
  *
- * @returns \c true if any limit has been reached, \c false if not.
+ * @returns @c true if any limit has been reached, @c false if not.
  * @param   msTimestamp         Timestamp (PTS, in ms) to check for.
  */
@@ -275 +275 @@
  * Returns whether a recording stream is ready (e.g. enabled and active) or not.
  *
- * @returns \c true if ready, \c false if not.
+ * @returns @c true if ready, @c false if not.
  */
 bool RecordingStream::IsReady(void) const

trunk/src/VBox/Main/xml/Settings.cpp

@@ -3047 +3047 @@
  * Check if all settings have default values.
  *
- * @returns \c true if default, \c false if not.
+ * @returns @c true if default, @c false if not.
  */
 bool RecordingScreenSettings::areDefaultSettings(void) const
@@ -3090 +3090 @@
  * Returns if a certain recording feature is enabled or not.
  *
- * @returns \c true if the feature is enabled, \c false if not.
+ * @returns @c true if the feature is enabled, @c false if not.
  * @param   enmFeature          Feature to check.
  */
@@ -8787 +8787 @@
  * for AudioDriverType_DirectSound when compiled on a Linux host.
  *
-*  @return \c true if the current host supports the driver, \c false if not.
+*  @return @c true if the current host supports the driver, @c false if not.
  * @param enmDrvType            AudioDriverType_* enum to test.
  */