diff options
| author | Josh Coalson <jcoalson@users.sourceforce.net> | 2004-07-16 00:16:08 +0000 |
|---|---|---|
| committer | Josh Coalson <jcoalson@users.sourceforce.net> | 2004-07-16 00:16:08 +0000 |
| commit | cd5b1a638cb2a72df639af7990e8b6b4359617da (patch) | |
| tree | 20e5330d54c5262807ed34adcdc7d9944cb05a63 /include | |
| parent | d5c593b09adcce5bbe98a6bc1e13c01a1394e9f7 (diff) | |
| download | flac-cd5b1a638cb2a72df639af7990e8b6b4359617da.tar.gz | |
minor comment fixes
Diffstat (limited to 'include')
| -rw-r--r-- | include/OggFLAC/file_encoder.h | 2 | ||||
| -rw-r--r-- | include/OggFLAC/seekable_stream_encoder.h | 2 | ||||
| -rw-r--r-- | include/OggFLAC/stream_encoder.h | 6 |
3 files changed, 7 insertions, 3 deletions
diff --git a/include/OggFLAC/file_encoder.h b/include/OggFLAC/file_encoder.h index 73c88d9f..fb5d5525 100644 --- a/include/OggFLAC/file_encoder.h +++ b/include/OggFLAC/file_encoder.h @@ -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 diff --git a/include/OggFLAC/seekable_stream_encoder.h b/include/OggFLAC/seekable_stream_encoder.h index a93481cb..6735ec63 100644 --- a/include/OggFLAC/seekable_stream_encoder.h +++ b/include/OggFLAC/seekable_stream_encoder.h @@ -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 diff --git a/include/OggFLAC/stream_encoder.h b/include/OggFLAC/stream_encoder.h index 5164b596..016ac1dd 100644 --- a/include/OggFLAC/stream_encoder.h +++ b/include/OggFLAC/stream_encoder.h @@ -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 |