claunia/flac
1
0
Fork 0
mirror of https://github.com/claunia/flac.git synced 2025-12-16 18:54:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

more doxygen comments

Browse Source
This commit is contained in:
Josh Coalson
2002-08-16 03:09:06 +00:00
parent 724b532b66
commit efc6c90ea8
12 changed files with 437 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
include/FLAC/format.h
View File

@@ -614,19 +614,30 @@ extern const unsigned FLAC__STREAM_METADATA_LENGTH_LEN; /**< == 24 (bits) */
*/
FLAC__bool FLAC__format_sample_rate_is_valid(unsigned sample_rate);
/** Check a seektable to see if it conforms to the FLAC specification.
/** Check a seek table to see if it conforms to the FLAC specification.
* See the format specification for limits on the contents of the
* seektable.
* seek table.
*
* \param object A pointer to a seek table to be checked.
* \param seek_table A pointer to a seek table to be checked.
* \assert
* \code object != NULL \endcode
* \code seek_table != NULL \endcode
* \retval FLAC__bool
* \c false if seek table is illegal, else \c true.
*/
FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *object);
FLAC__bool FLAC__format_seektable_is_legal(const FLAC__StreamMetadata_SeekTable *seek_table);
/* @@@@ document */
/** Sort a seek table's seek points according to the format specification.
* This includes a "unique-ification" step to remove duplicates, i.e.
* seek points with identical \a sample_number values. Duplicate seek
* points are converted into placeholder points and sorted to the end of
* the table.
*
* \param seek_table A pointer to a seek table to be sorted.
* \assert
* \code seek_table != NULL \endcode
* \retval unsigned
* The number of duplicate seek points converted into placeholders.
*/
unsigned FLAC__format_seektable_sort(FLAC__StreamMetadata_SeekTable *seek_table);
/* \} */