minor comment fixes
authorJosh Coalson <jcoalson@users.sourceforce.net>
Fri, 16 Jul 2004 00:16:08 +0000 (00:16 +0000)
committerJosh Coalson <jcoalson@users.sourceforce.net>
Fri, 16 Jul 2004 00:16:08 +0000 (00:16 +0000)
include/OggFLAC/file_encoder.h
include/OggFLAC/seekable_stream_encoder.h
include/OggFLAC/stream_encoder.h

index 73c88d9..fb5d552 100644 (file)
@@ -180,7 +180,7 @@ OggFLAC_API void OggFLAC__file_encoder_delete(OggFLAC__FileEncoder *encoder);
 
 /** Set the serial number for the FLAC stream.
  *
- * \default \c NULL, 0
+ * \default \c 0
  * \param  encoder        An encoder instance to set.
  * \param  serial_number  See above.
  * \assert
index a93481c..6735ec6 100644 (file)
@@ -269,7 +269,7 @@ OggFLAC_API void OggFLAC__seekable_stream_encoder_delete(OggFLAC__SeekableStream
 
 /** Set the serial number for the FLAC stream.
  *
- * \default \c NULL, 0
+ * \default \c 0
  * \param  encoder        An encoder instance to set.
  * \param  serial_number  See above.
  * \assert
index 5164b59..016ac1d 100644 (file)
@@ -202,7 +202,11 @@ OggFLAC_API void OggFLAC__stream_encoder_delete(OggFLAC__StreamEncoder *encoder)
 
 /** Set the serial number for the FLAC stream.
  *
- * \default \c NULL, 0
+ * \note
+ * It is recommended to set a serial number explicitly as the default of '0'
+ * may collide with other streams.
+ *
+ * \default \c 0
  * \param  encoder        An encoder instance to set.
  * \param  serial_number  See above.
  * \assert