Changeset 2875 for pjproject/trunk/pjmedia/include/pjmedia-codec/config.h

Timestamp:

Aug 13, 2009 3:57:26 PM (15 years ago)

Author:

bennylp

Message:

Misc (#915):

• updated missing doxygen documentation from various PJMEDIA-CODEC headers

File:

• pjproject/trunk/pjmedia/include/pjmedia-codec/config.h (modified) (3 diffs)

pjproject/trunk/pjmedia/include/pjmedia-codec/config.h

@@ -21 +21 @@
 #define __PJMEDIA_CODEC_CONFIG_H__
 
+/**
+ * @file config.h
+ * @brief PJMEDIA-CODEC compile time settings
+ */
+
+/**
+ * @defgroup pjmedia_codec_config PJMEDIA-CODEC Compile Time Settings
+ * @ingroup PJMEDIA_CODEC
+ * @brief Various compile time settings such as to enable/disable codecs
+ * @{
+ */
+
 #include <pjmedia/types.h>
+
 
 /*
@@ -204 +217 @@
 #endif
 
+/**
+ * Enable AMR passthrough codec.
+ *
+ * Default: 1
+ */
 #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_AMR
 #   define PJMEDIA_HAS_PASSTHROUGH_CODEC_AMR    1
 #endif
 
+/**
+ * Enable G.729 passthrough codec.
+ *
+ * Default: 1
+ */
 #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_G729
 #   define PJMEDIA_HAS_PASSTHROUGH_CODEC_G729   1
 #endif
 
+/**
+ * Enable iLBC passthrough codec.
+ *
+ * Default: 1
+ */
 #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_ILBC
 #   define PJMEDIA_HAS_PASSTHROUGH_CODEC_ILBC   1
 #endif
 
+/**
+ * Enable PCMU passthrough codec.
+ *
+ * Default: 1
+ */
 #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMU
 #   define PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMU   1
 #endif
 
+/**
+ * Enable PCMA passthrough codec.
+ *
+ * Default: 1
+ */
 #ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMA
 #   define PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMA   1
@@ -272 +310 @@
 #endif
 
+/**
+ * @}
+ */
+
 #endif  /* __PJMEDIA_CODEC_CONFIG_H__ */