From 396313c9d0bac849f378f2d7072e2ea55ddc8e9f Mon Sep 17 00:00:00 2001 From: Martijn van Beurden Date: Mon, 17 Oct 2022 19:20:32 +0200 Subject: [doxygen] Change links from local to xiph.org/flac --- include/FLAC++/metadata.h | 16 ++++++------ include/FLAC/all.h | 8 +++--- include/FLAC/format.h | 60 +++++++++++++++++++++---------------------- include/FLAC/metadata.h | 2 +- include/FLAC/stream_decoder.h | 2 +- include/FLAC/stream_encoder.h | 14 +++++----- 6 files changed, 51 insertions(+), 51 deletions(-) diff --git a/include/FLAC++/metadata.h b/include/FLAC++/metadata.h index 96d01083..1599ec45 100644 --- a/include/FLAC++/metadata.h +++ b/include/FLAC++/metadata.h @@ -274,7 +274,7 @@ namespace FLAC { /** STREAMINFO metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API StreamInfo : public Prototype { public: @@ -323,7 +323,7 @@ namespace FLAC { //@} //@{ - /** See format specification. */ + /** See format specification. */ uint32_t get_min_blocksize() const; uint32_t get_max_blocksize() const; uint32_t get_min_framesize() const; @@ -348,7 +348,7 @@ namespace FLAC { /** PADDING metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API Padding : public Prototype { public: @@ -407,7 +407,7 @@ namespace FLAC { /** APPLICATION metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API Application : public Prototype { public: @@ -466,7 +466,7 @@ namespace FLAC { /** SEEKTABLE metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API SeekTable : public Prototype { public: @@ -553,7 +553,7 @@ namespace FLAC { /** VORBIS_COMMENT metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API VorbisComment : public Prototype { public: @@ -720,7 +720,7 @@ namespace FLAC { /** CUESHEET metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API CueSheet : public Prototype { public: @@ -859,7 +859,7 @@ namespace FLAC { /** PICTURE metadata block. * See the \link flacpp_metadata_object overview \endlink for more, - * and the format specification. + * and the format specification. */ class FLACPP_API Picture : public Prototype { public: diff --git a/include/FLAC/all.h b/include/FLAC/all.h index 8c6cdc3c..a6a012fc 100644 --- a/include/FLAC/all.h +++ b/include/FLAC/all.h @@ -52,7 +52,7 @@ * level idea of the structure and how to find the information you * need. As a prerequisite you should have at least a basic * knowledge of the FLAC format, documented - * here. + * here. * * \section c_api FLAC C API * @@ -64,7 +64,7 @@ * * By writing a little code and linking against libFLAC, it is * relatively easy to add FLAC support to another program. The - * library is licensed under Xiph's BSD license. + * library is licensed under Xiph's BSD license. * Complete source code of libFLAC as well as the command-line * encoder and plugins is available and is a useful source of * examples. @@ -97,7 +97,7 @@ * example /usr/include/FLAC++/...). * * libFLAC++ is also licensed under - * Xiph's BSD license. + * Xiph's BSD license. * * \section getting_started Getting Started * @@ -113,7 +113,7 @@ * functions through the links in top bar across this page. * * If you prefer a more hands-on approach, you can jump right to some - * example code. + * example code. * * \section porting_guide Porting Guide * diff --git a/include/FLAC/format.h b/include/FLAC/format.h index 99d637f0..2d548437 100644 --- a/include/FLAC/format.h +++ b/include/FLAC/format.h @@ -60,7 +60,7 @@ extern "C" { * structures used by the rest of the interfaces. * * First, you should be familiar with the - * FLAC format. Many of the values here + * FLAC format. Many of the values here * follow directly from the specification. As a user of libFLAC, the * interesting parts really are the structures that describe the frame * header and metadata blocks. @@ -225,7 +225,7 @@ typedef struct { */ } FLAC__EntropyCodingMethod_PartitionedRiceContents; -/** Header for a Rice partitioned residual. (c.f. format specification) +/** Header for a Rice partitioned residual. (c.f. format specification) */ typedef struct { @@ -247,7 +247,7 @@ extern FLAC_API const uint32_t FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCA extern FLAC_API const uint32_t FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_ESCAPE_PARAMETER; /**< == (1<format specification) +/** Header for the entropy coding method. (c.f. format specification) */ typedef struct { FLAC__EntropyCodingMethodType type; @@ -276,7 +276,7 @@ typedef enum { extern FLAC_API const char * const FLAC__SubframeTypeString[]; -/** CONSTANT subframe. (c.f. format specification) +/** CONSTANT subframe. (c.f. format specification) */ typedef struct { FLAC__int64 value; /**< The constant signal value. */ @@ -289,7 +289,7 @@ typedef enum { } FLAC__VerbatimSubframeDataType; -/** VERBATIM subframe. (c.f. format specification) +/** VERBATIM subframe. (c.f. format specification) */ typedef struct { union { @@ -300,7 +300,7 @@ typedef struct { } FLAC__Subframe_Verbatim; -/** FIXED subframe. (c.f. format specification) +/** FIXED subframe. (c.f. format specification) */ typedef struct { FLAC__EntropyCodingMethod entropy_coding_method; @@ -317,7 +317,7 @@ typedef struct { } FLAC__Subframe_Fixed; -/** LPC subframe. (c.f. format specification) +/** LPC subframe. (c.f. format specification) */ typedef struct { FLAC__EntropyCodingMethod entropy_coding_method; @@ -346,7 +346,7 @@ extern FLAC_API const uint32_t FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN; /**< extern FLAC_API const uint32_t FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN; /**< == 5 (bits) */ -/** FLAC subframe structure. (c.f. format specification) +/** FLAC subframe structure. (c.f. format specification) */ typedef struct { FLAC__SubframeType type; @@ -413,7 +413,7 @@ typedef enum { extern FLAC_API const char * const FLAC__FrameNumberTypeString[]; -/** FLAC frame header structure. (c.f. format specification) +/** FLAC frame header structure. (c.f. format specification) */ typedef struct { uint32_t blocksize; @@ -462,7 +462,7 @@ extern FLAC_API const uint32_t FLAC__FRAME_HEADER_ZERO_PAD_LEN; /**< == 1 (bit) extern FLAC_API const uint32_t FLAC__FRAME_HEADER_CRC_LEN; /**< == 8 (bits) */ -/** FLAC frame footer structure. (c.f. format specification) +/** FLAC frame footer structure. (c.f. format specification) */ typedef struct { FLAC__uint16 crc; @@ -475,7 +475,7 @@ typedef struct { extern FLAC_API const uint32_t FLAC__FRAME_FOOTER_CRC_LEN; /**< == 16 (bits) */ -/** FLAC frame structure. (c.f. format specification) +/** FLAC frame structure. (c.f. format specification) */ typedef struct { FLAC__FrameHeader header; @@ -496,25 +496,25 @@ typedef struct { typedef enum { FLAC__METADATA_TYPE_STREAMINFO = 0, - /**< STREAMINFO block */ + /**< STREAMINFO block */ FLAC__METADATA_TYPE_PADDING = 1, - /**< PADDING block */ + /**< PADDING block */ FLAC__METADATA_TYPE_APPLICATION = 2, - /**< APPLICATION block */ + /**< APPLICATION block */ FLAC__METADATA_TYPE_SEEKTABLE = 3, - /**< SEEKTABLE block */ + /**< SEEKTABLE block */ FLAC__METADATA_TYPE_VORBIS_COMMENT = 4, - /**< VORBISCOMMENT block (a.k.a. FLAC tags) */ + /**< VORBISCOMMENT block (a.k.a. FLAC tags) */ FLAC__METADATA_TYPE_CUESHEET = 5, - /**< CUESHEET block */ + /**< CUESHEET block */ FLAC__METADATA_TYPE_PICTURE = 6, - /**< PICTURE block */ + /**< PICTURE block */ FLAC__METADATA_TYPE_UNDEFINED = 7, /**< marker to denote beginning of undefined type range; this number will increase as new metadata types are added */ @@ -531,7 +531,7 @@ typedef enum { extern FLAC_API const char * const FLAC__MetadataTypeString[]; -/** FLAC STREAMINFO structure. (c.f. format specification) +/** FLAC STREAMINFO structure. (c.f. format specification) */ typedef struct { uint32_t min_blocksize, max_blocksize; @@ -556,7 +556,7 @@ extern FLAC_API const uint32_t FLAC__STREAM_METADATA_STREAMINFO_MD5SUM_LEN; /**< /** The total stream length of the STREAMINFO block in bytes. */ #define FLAC__STREAM_METADATA_STREAMINFO_LENGTH (34u) -/** FLAC PADDING structure. (c.f. format specification) +/** FLAC PADDING structure. (c.f. format specification) */ typedef struct { int dummy; @@ -567,7 +567,7 @@ typedef struct { } FLAC__StreamMetadata_Padding; -/** FLAC APPLICATION structure. (c.f. format specification) +/** FLAC APPLICATION structure. (c.f. format specification) */ typedef struct { FLAC__byte id[4]; @@ -576,7 +576,7 @@ typedef struct { extern FLAC_API const uint32_t FLAC__STREAM_METADATA_APPLICATION_ID_LEN; /**< == 32 (bits) */ -/** SeekPoint structure used in SEEKTABLE blocks. (c.f. format specification) +/** SeekPoint structure used in SEEKTABLE blocks. (c.f. format specification) */ typedef struct { FLAC__uint64 sample_number; @@ -604,7 +604,7 @@ extern FLAC_API const uint32_t FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN extern FLAC_API const FLAC__uint64 FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER; -/** FLAC SEEKTABLE structure. (c.f. format specification) +/** FLAC SEEKTABLE structure. (c.f. format specification) * * \note From the format specification: * - The seek points must be sorted by ascending sample number. @@ -622,7 +622,7 @@ typedef struct { } FLAC__StreamMetadata_SeekTable; -/** Vorbis comment entry structure used in VORBIS_COMMENT blocks. (c.f. format specification) +/** Vorbis comment entry structure used in VORBIS_COMMENT blocks. (c.f. format specification) * * For convenience, the APIs maintain a trailing NUL character at the end of * \a entry which is not counted toward \a length, i.e. @@ -636,7 +636,7 @@ typedef struct { extern FLAC_API const uint32_t FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN; /**< == 32 (bits) */ -/** FLAC VORBIS_COMMENT structure. (c.f. format specification) +/** FLAC VORBIS_COMMENT structure. (c.f. format specification) */ typedef struct { FLAC__StreamMetadata_VorbisComment_Entry vendor_string; @@ -648,7 +648,7 @@ extern FLAC_API const uint32_t FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS /** FLAC CUESHEET track index structure. (See the - * format specification for + * format specification for * the full description of each field.) */ typedef struct { @@ -667,7 +667,7 @@ extern FLAC_API const uint32_t FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN /** FLAC CUESHEET track structure. (See the - * format specification for + * format specification for * the full description of each field.) */ typedef struct { @@ -704,7 +704,7 @@ extern FLAC_API const uint32_t FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_ /** FLAC CUESHEET structure. (See the - * format specification + * format specification * for the full description of each field.) */ typedef struct { @@ -770,7 +770,7 @@ typedef enum { extern FLAC_API const char * const FLAC__StreamMetadata_Picture_TypeString[]; /** FLAC PICTURE structure. (See the - * format specification + * format specification * for the full description of each field.) */ typedef struct { @@ -836,7 +836,7 @@ typedef struct { } FLAC__StreamMetadata_Unknown; -/** FLAC metadata block structure. (c.f. format specification) +/** FLAC metadata block structure. (c.f. format specification) */ typedef struct FLAC__StreamMetadata { FLAC__MetadataType type; diff --git a/include/FLAC/metadata.h b/include/FLAC/metadata.h index bf1bffe4..651b7405 100644 --- a/include/FLAC/metadata.h +++ b/include/FLAC/metadata.h @@ -510,7 +510,7 @@ FLAC_API FLAC__MetadataType FLAC__metadata_simple_iterator_get_block_type(const * \retval uint32_t * The length of the metadata block at the current iterator position. * The is same length as that in the - * metadata block header, + * metadata block header, * i.e. the length of the metadata body that follows the header. */ FLAC_API uint32_t FLAC__metadata_simple_iterator_get_block_length(const FLAC__Metadata_SimpleIterator *iterator); diff --git a/include/FLAC/stream_decoder.h b/include/FLAC/stream_decoder.h index 2d285aec..f4e16488 100644 --- a/include/FLAC/stream_decoder.h +++ b/include/FLAC/stream_decoder.h @@ -681,7 +681,7 @@ typedef FLAC__bool (*FLAC__StreamDecoderEofCallback)(const FLAC__StreamDecoder * * samples of length \a frame->header.blocksize. * Channels will be ordered according to the FLAC * specification; see the documentation for the - * frame header. + * frame header. * \param client_data The callee's client data set through * FLAC__stream_decoder_init_*(). * \retval FLAC__StreamDecoderWriteStatus diff --git a/include/FLAC/stream_encoder.h b/include/FLAC/stream_encoder.h index 1db43a27..4ab4dce4 100644 --- a/include/FLAC/stream_encoder.h +++ b/include/FLAC/stream_encoder.h @@ -129,8 +129,8 @@ extern "C" { * Unlike the decoders, the stream encoder has many options that can * affect the speed and compression ratio. When setting these parameters * you should have some basic knowledge of the format (see the - * user-level documentation - * or the formal description). The + * user-level documentation + * or the formal description). The * FLAC__stream_encoder_set_*() functions themselves do not validate the * values as many are interdependent. The FLAC__stream_encoder_init_*() * functions will do this, so make sure to pay attention to the state @@ -330,7 +330,7 @@ typedef enum { /**< The specified block size is less than the maximum LPC order. */ FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE, - /**< The encoder is bound to the Subset but other settings violate it. */ + /**< The encoder is bound to the Subset but other settings violate it. */ FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA, /**< The metadata input to the encoder is invalid, in one of the following ways: @@ -742,7 +742,7 @@ FLAC_API FLAC__bool FLAC__stream_encoder_set_ogg_serial_number(FLAC__StreamEncod */ FLAC_API FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value); -/** Set the Subset flag. If \c true, +/** Set the Subset flag. If \c true, * the encoder will comply with the Subset and will check the * settings during FLAC__stream_encoder_init_*() to see if all settings * comply. If \c false, the settings may take advantage of the full @@ -1295,7 +1295,7 @@ FLAC_API void FLAC__stream_encoder_get_verify_decoder_error_stats(const FLAC__St */ FLAC_API FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder); -/** Get the Subset flag. +/** Get the Subset flag. * * \param encoder An encoder instance to query. * \assert @@ -1781,7 +1781,7 @@ FLAC_API FLAC__bool FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder); * * For applications where channel order is important, channels must * follow the order as described in the - * frame header. + * frame header. * * \param encoder An initialized encoder instance in the OK state. * \param buffer An array of pointers to each channel's signal. @@ -1810,7 +1810,7 @@ FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, c * * For applications where channel order is important, channels must * follow the order as described in the - * frame header. + * frame header. * * \param encoder An initialized encoder instance in the OK state. * \param buffer An array of channel-interleaved data (see above). -- cgit v1.2.1