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 docs

Browse Source
This commit is contained in:
Josh Coalson
2002-07-27 04:59:54 +00:00
parent adea3dea13
commit f6efd9cec9
8 changed files with 1190 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/FLAC/file_decoder.h
View File

@@ -188,7 +188,7 @@ FLAC__FileDecoder *FLAC__file_decoder_new();
* \assert
* \code decoder != NULL \endcode
*/
void FLAC__file_decoder_delete(FLAC__FileDecoder *);
void FLAC__file_decoder_delete(FLAC__FileDecoder *decoder);
/***********************************************************************

14
include/FLAC/format.h
View File

@@ -426,11 +426,22 @@ typedef struct {
/** An enumeration of the available metadata block types. */
typedef enum {
FLAC__METADATA_TYPE_STREAMINFO = 0,
/**< <A HREF="../format.html#metadata_block_streaminfo">STREAMINFO</A> block */
FLAC__METADATA_TYPE_PADDING = 1,
/**< <A HREF="../format.html#metadata_block_padding"PADDING</A> block */
FLAC__METADATA_TYPE_APPLICATION = 2,
/**< <A HREF="../format.html#metadata_block_application"APPLICATION</A> block */
FLAC__METADATA_TYPE_SEEKTABLE = 3,
FLAC__METADATA_TYPE_VORBIS_COMMENT = 4
/**< <A HREF="../format.html#metadata_block_seektable"SEEKTABLE</A> block */
FLAC__METADATA_TYPE_VORBIS_COMMENT = 4,
/**< <A HREF="../format.html#metadata_block_vorbis_comment"VORBISCOMMENT</A> block */
} FLAC__MetadataType;
/** Maps a FLAC__MetadataType to a C string.
@@ -440,6 +451,7 @@ typedef enum {
*/
extern const char * const FLAC__MetadataTypeString[];
/** FLAC STREAMINFO structure. (c.f. <A HREF="../format.html#metadata_block_streaminfo">format specification</A>)
*/
typedef struct {

2
include/FLAC/stream_decoder.h
View File

@@ -37,7 +37,7 @@ extern "C" {
* \link flac_stream_decoder stream decoder \endlink module.
*/
/** \defgroup flac_decoder FLAC/*_decoder.h: decoder interfaces
/** \defgroup flac_decoder FLAC/ *_decoder.h: decoder interfaces
* \ingroup flac
*
* \brief

7
include/FLAC/stream_encoder.h
View File

@@ -37,7 +37,7 @@ extern "C" {
* \link flac_stream_encoder stream encoder \endlink module.
*/
/** \defgroup flac_encoder FLAC/*_encoder.h: encoder interfaces
/** \defgroup flac_encoder FLAC/ *_encoder.h: encoder interfaces
* \ingroup flac
*
* \brief
@@ -48,11 +48,6 @@ extern "C" {
* within a file while encoding seemed like too obscure a feature.
*/
/** \defgroup flac_encoder FLAC/*_encoder.h: encoder interfaces
* \ingroup flac
*
*/
/** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
* \ingroup flac_encoder
*