summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGregory Maxwell <greg@xiph.org>2012-06-10 21:30:01 -0400
committerGregory Maxwell <greg@xiph.org>2012-06-10 21:30:01 -0400
commitdaa14598eb07cd5a0ac55f2a49f80a21574f21e1 (patch)
tree7eb37887e8b395532ce7a4a27ba6b136a4b6e5d3
parent1f65ce89b03a1d9c9bae9fa3ed0109b3bde21a60 (diff)
downloadopus-daa14598eb07cd5a0ac55f2a49f80a21574f21e1.tar.gz
Add brief descriptions to the encode/decode groups to avoid weird autobreif strings.
-rw-r--r--include/opus.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/opus.h b/include/opus.h
index baf9d738..a7cd78a6 100644
--- a/include/opus.h
+++ b/include/opus.h
@@ -73,6 +73,8 @@ extern "C" {
/** @defgroup opus_encoder Opus Encoder
* @{
*
+ * @brief This page describes the process and functions used to encode Opus.
+ *
* Since Opus is a stateful codec, the encoding process starts with creating an encoder
* state. This can be done with:
*
@@ -280,6 +282,7 @@ OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...) OPUS_ARG_NON
/** @defgroup opus_decoder Opus Decoder
* @{
*
+ * @brief This page describes the process and functions used to decode Opus.
*
* The decoding process also starts with creating a decoder
* state. This can be done with: