Add brief descriptions to the encode/decode groups to avoid weird autobreif strings.
authorGregory Maxwell <greg@xiph.org>
Mon, 11 Jun 2012 01:30:01 +0000 (21:30 -0400)
committerGregory Maxwell <greg@xiph.org>
Mon, 11 Jun 2012 01:30:01 +0000 (21:30 -0400)
include/opus.h

index baf9d73..a7cd78a 100644 (file)
@@ -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: