log: Document AV_LOG_C usage
authorLuca Barbato <lu_zero@gentoo.org>
Thu, 3 Apr 2014 13:51:48 +0000 (13:51 +0000)
committerVittorio Giovara <vittorio.giovara@gmail.com>
Thu, 3 Apr 2014 16:43:24 +0000 (18:43 +0200)
And move outside the wrong doxygen group.

libavutil/log.h

index 2f7811c..4e4424a 100644 (file)
@@ -144,16 +144,18 @@ typedef struct AVClass {
 #define AV_LOG_DEBUG    48
 
 /**
- * Sets additional colors for extended debugging sessions.
- * Requires 256color terminal support. Use outside debugging is not
- * recommended.
+ * @}
  */
 
-#define AV_LOG_C(x) (x << 8)
-
 /**
- * @}
+ * Sets additional colors for extended debugging sessions.
+ * @code
+   av_log(ctx, AV_LOG_DEBUG|AV_LOG_C(134), "Message in purple\n");
+   @endcode
+ * Requires 256color terminal support. Uses outside debugging is not
+ * recommended.
  */
+#define AV_LOG_C(x) (x << 8)
 
 /**
  * Send the specified message to the log if the level is less than or equal