From 791824a9cb75d2cefeda1a60033d98e78a68726c Mon Sep 17 00:00:00 2001
From: Brad <1676751+Sinkleberg@users.noreply.github.com>
Date: Fri, 6 Nov 2026 18:41:01 -0500
Subject: [PATCH] Link format.h documentation to RFC 9639
---
include/FLAC/format.h | 60 +++++++++++++++++++++----------------------
1 file changed, 30 insertions(+), 30 deletions(-)
diff --git a/include/FLAC/format.h b/include/FLAC/format.h
index 48876d6739..68322bd4e7 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;