Commit ba26e4e5 authored by Josh Coalson's avatar Josh Coalson
Browse files

comments

parent 1a8afc70
...@@ -55,7 +55,7 @@ extern "C" { ...@@ -55,7 +55,7 @@ extern "C" {
* \ingroup flac * \ingroup flac
* *
* \brief * \brief
* This module describes the two encoder layers provided by libFLAC. * This module describes the three encoder layers provided by libFLAC.
* *
* For encoding FLAC streams, libFLAC provides three layers of access. The * For encoding FLAC streams, libFLAC provides three layers of access. The
* lowest layer is non-seekable stream-level encoding, the next is seekable * lowest layer is non-seekable stream-level encoding, the next is seekable
......
...@@ -571,11 +571,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_reset(OggFLAC__StreamDecoder *dec ...@@ -571,11 +571,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_reset(OggFLAC__StreamDecoder *dec
* \code decoder != NULL \endcode * \code decoder != NULL \endcode
* \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode * \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
* \retval FLAC__bool * \retval FLAC__bool
* \c false if any read or write error occurred (except * \c false if any fatal read, write, or memory allocation error
* \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c true; * occurred (meaning decoding must stop), else \c true; for more
* in any case, check the decoder state with * information about the decoder, check the decoder state with
* OggFLAC__stream_decoder_get_state() to see what went wrong or to * OggFLAC__stream_decoder_get_state().
* check for lost synchronization (a sign of stream corruption).
*/ */
OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder); OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder);
...@@ -588,11 +587,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDec ...@@ -588,11 +587,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDec
* \code decoder != NULL \endcode * \code decoder != NULL \endcode
* \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode * \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
* \retval FLAC__bool * \retval FLAC__bool
* \c false if any read or write error occurred (except * \c false if any fatal read, write, or memory allocation error
* \c OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c true; * occurred (meaning decoding must stop), else \c true; for more
* in any case, check the decoder state with * information about the decoder, check the decoder state with
* OggFLAC__stream_decoder_get_state() to see what went wrong or to * OggFLAC__stream_decoder_get_state().
* check for lost synchronization (a sign of stream corruption).
*/ */
OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder); OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder);
...@@ -605,11 +603,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(Ogg ...@@ -605,11 +603,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(Ogg
* \code decoder != NULL \endcode * \code decoder != NULL \endcode
* \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode * \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
* \retval FLAC__bool * \retval FLAC__bool
* \c false if any read or write error occurred (except * \c false if any fatal read, write, or memory allocation error
* \c OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c true; * occurred (meaning decoding must stop), else \c true; for more
* in any case, check the decoder state with * information about the decoder, check the decoder state with
* OggFLAC__stream_decoder_get_state() to see what went wrong or to * OggFLAC__stream_decoder_get_state().
* check for lost synchronization (a sign of stream corruption).
*/ */
OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder); OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment