minor comments
authorJosh Coalson <jcoalson@users.sourceforce.net>
Tue, 23 Sep 2003 20:35:03 +0000 (20:35 +0000)
committerJosh Coalson <jcoalson@users.sourceforce.net>
Tue, 23 Sep 2003 20:35:03 +0000 (20:35 +0000)
include/FLAC/stream_decoder.h
include/OggFLAC/seekable_stream_decoder.h
include/OggFLAC/stream_decoder.h

index 7c82653..d2fb6bb 100644 (file)
@@ -677,7 +677,7 @@ FLAC_API unsigned FLAC__stream_decoder_get_blocksize(const FLAC__StreamDecoder *
  * \assert
  *    \code decoder != NULL \endcode
  * \retval FLAC__StreamDecoderState
- *    \c FLAC__STREAM_DECODER_SEARCH_FOR_MEATADATA if initialization was
+ *    \c FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization was
  *    successful; see FLAC__StreamDecoderState for the meanings of other
  *    return values.
  */
index 6314f0e..ade8f66 100644 (file)
@@ -123,7 +123,7 @@ typedef struct {
        struct OggFLAC__SeekableStreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
 } OggFLAC__SeekableStreamDecoder;
 
-/*@@@ document */
+/*@@@@ document */
 typedef FLAC__SeekableStreamDecoderReadStatus (*OggFLAC__SeekableStreamDecoderReadCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
 typedef FLAC__SeekableStreamDecoderSeekStatus (*OggFLAC__SeekableStreamDecoderSeekCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
 typedef FLAC__SeekableStreamDecoderTellStatus (*OggFLAC__SeekableStreamDecoderTellCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
@@ -165,7 +165,7 @@ OggFLAC_API void OggFLAC__seekable_stream_decoder_delete(OggFLAC__SeekableStream
  *
  ***********************************************************************/
 
-/*@@@inherit set_serial_number*/
+/*@@@@inherit set_serial_number*/
 
 /** Set the "MD5 signature checking" flag.
  *  This is inherited from FLAC__SeekableStreamDecoder; see
index f3e5a83..9d9ed9f 100644 (file)
@@ -69,7 +69,7 @@ extern "C" {
  *  This module contains the functions which implement the stream
  *  decoder.
  *
- * The interface here is identical to FLAC's stream decoder,
+ * The interface here is nearly identical to FLAC's stream decoder,
  * including the callbacks, with the addition of
  * OggFLAC__stream_decoder_set_serial_number().  See the
  * \link flac_stream_decoder FLAC stream decoder module \endlink
@@ -317,7 +317,7 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_client_data(OggFLAC__StreamDe
 
 /** Set the serial number for the Ogg stream.
  * The default behavior is to use the serial number of the first Ogg
- * page.  Setting a serial number here will explicitly define which
+ * page.  Setting a serial number here will explicitly specify which
  * stream is to be decoded.
  *
  * \default \c use serial number of first page