shithub: opusfile

--- a/include/opusfile.h

+++ b/include/opusfile.h

@@ -147,7 +147,7 @@

 /**@endcond*/

 /**\defgroup error_codes Error Codes*/

-/*@{*/

+/**@{*/

 /**\name List of possible error codes

    Many of the functions in this library return a negative error code when a

     function fails.

@@ -154,7 +154,7 @@

    This list provides a brief explanation of the common errors.

    See each individual function for more details on what a specific error code

     means in that context.*/

-/*@{*/

+/**@{*/

 /**A request did not succeed.*/

 #define OP_FALSE         (-1)

@@ -200,11 +200,11 @@

 /**The first or last granule position of a link failed basic validity checks.*/

 #define OP_EBADTIMESTAMP (-139)

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 /**\defgroup header_info Header Information*/

-/*@{*/

+/**@{*/

 /**The maximum number of channels in an Ogg Opus stream.*/

 #define OPUS_CHANNEL_COUNT_MAX (255)

@@ -311,7 +311,7 @@

};

 /**\name Picture tag image formats*/

-/*@{*/

+/**@{*/

 /**The MIME type was not recognized, or the image data did not match the

     declared MIME type.*/

@@ -325,7 +325,7 @@

 /**The image is a GIF.*/

 #define OP_PIC_FORMAT_GIF     (3)

-/*@}*/

+/**@}*/

 /**The contents of a METADATA_BLOCK_PICTURE tag.*/

 struct OpusPictureTag{

@@ -398,7 +398,7 @@

    These can be used to query the headers returned by <tt>libopusfile</tt>, or

     to parse Opus headers from sources other than an Ogg Opus stream, provided

     they use the same format.*/

-/*@{*/

+/**@{*/

 /**Parses the contents of the ID header packet of an Ogg Opus stream.

    \param[out] _head Returns the contents of the parsed packet.

@@ -671,12 +671,12 @@

    \param _pic The #OpusPictureTag structure to clear.*/

 void opus_picture_tag_clear(OpusPictureTag *_pic) OP_ARG_NONNULL(1);

-/*@}*/

+/**@}*/

-/*@}*/

+/**@}*/

 /**\defgroup url_options URL Reading Options*/

-/*@{*/

+/**@{*/

 /**\name URL reading options

    Options for op_url_stream_create() and associated functions.

    These allow you to provide proxy configuration parameters, skip SSL

@@ -685,7 +685,7 @@

     times, only the value specified by the last occurrence has an effect

     (unless otherwise specified).

    They may be expanded in the future.*/

-/*@{*/

+/**@{*/

 /**@cond PRIVATE*/

@@ -843,11 +843,11 @@

 #define OP_GET_SERVER_INFO(_info) \

  OP_URL_OPT(OP_GET_SERVER_INFO_REQUEST),OP_CHECK_SERVER_INFO_PTR(_info)

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 /**\defgroup stream_callbacks Abstract Stream Reading Interface*/

-/*@{*/

+/**@{*/

 /**\name Functions for reading from streams

    These functions define the interface used to read from and seek in a stream

     of data.

@@ -856,7 +856,7 @@

    These functions also include some convenience routines for working with

     standard <code>FILE</code> pointers, complete streams stored in a single

     block of memory, or URLs.*/

-/*@{*/

+/**@{*/

 /**Reads up to \a _nbytes bytes of data from \a _stream.

    \param      _stream The stream to read from.

@@ -1034,11 +1034,11 @@

 OP_WARN_UNUSED_RESULT void *op_url_stream_create(OpusFileCallbacks *_cb,

  const char *_url,...) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 /**\defgroup stream_open_close Opening and Closing*/

-/*@{*/

+/**@{*/

 /**\name Functions for opening and closing streams

    These functions allow you to test a stream to see if it is Opus, open it,

@@ -1045,7 +1045,7 @@

     and close it.

    Several flavors are provided for each of the built-in stream types, plus a

     more general version which takes a set of application-provided callbacks.*/

-/*@{*/

+/**@{*/

 /**Test to see if this is an Opus stream.

    For good results, you will need at least 57 bytes (for a pure Opus-only

@@ -1418,11 +1418,11 @@

    \param _of The \c OggOpusFile to free.*/

 void op_free(OggOpusFile *_of);

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 /**\defgroup stream_info Stream Information*/

-/*@{*/

+/**@{*/

 /**\name Functions for obtaining information about streams

    These functions allow you to get basic information about a stream, including

@@ -1437,7 +1437,7 @@

     streams returned by op_test_callbacks() or one of the associated

     convenience functions.

    Their documention will indicate so explicitly.*/

-/*@{*/

+/**@{*/

 /**Returns whether or not the stream being read is seekable.

    This is true if

@@ -1638,11 +1638,11 @@

    \retval #OP_EINVAL The stream was only partially open.*/

 ogg_int64_t op_pcm_tell(const OggOpusFile *_of) OP_ARG_NONNULL(1);

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 /**\defgroup stream_seeking Seeking*/

-/*@{*/

+/**@{*/

 /**\name Functions for seeking in Opus streams

    These functions let you seek in Opus streams, if the underlying stream

@@ -1667,7 +1667,7 @@

     values as would be obtained by decoding the stream straight through.

    However, such differences are expected to be smaller than the loss

     introduced by Opus's lossy compression.*/

-/*@{*/

+/**@{*/

 /**Seek to a byte offset relative to the <b>compressed</b> data.

    This also scans packets to update the PCM cursor.

@@ -1702,11 +1702,11 @@

                          seeking to the target destination was impossible.*/

 int op_pcm_seek(OggOpusFile *_of,ogg_int64_t _pcm_offset) OP_ARG_NONNULL(1);

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 /**\defgroup stream_decoding Decoding*/

-/*@{*/

+/**@{*/

 /**\name Functions for decoding audio data

    These functions retrieve actual decoded audio data from the stream.

@@ -1744,7 +1744,7 @@

    If you are reading from an <https:> URL (particularly if seeking is not

     supported), you should make sure to check for this error and warn the user

     appropriately.*/

-/*@{*/

+/**@{*/

 /**Indicates that the decoding callback should produce signed 16-bit

     native-endian output samples.*/

@@ -2150,8 +2150,8 @@

 OP_WARN_UNUSED_RESULT int op_read_float_stereo(OggOpusFile *_of,

  float *_pcm,int _buf_size) OP_ARG_NONNULL(1);

-/*@}*/

-/*@}*/

+/**@}*/

+/**@}*/

 # if OP_GNUC_PREREQ(4,0)

 #  pragma GCC visibility pop