codecparsers: Fix gtk-doc

Detected by initial pre-run of gi-scanner.
This commit is contained in:
Edward Hervey 2013-06-22 08:57:12 +02:00
parent 21ccbbffe5
commit b00192d7c0
5 changed files with 10 additions and 9 deletions

View File

@ -49,6 +49,7 @@ G_BEGIN_DECLS
#define GST_H264_IS_SI_SLICE(slice) (((slice)->type % 5) == GST_H264_SI_SLICE) #define GST_H264_IS_SI_SLICE(slice) (((slice)->type % 5) == GST_H264_SI_SLICE)
/** /**
* GstH264Profile:
* @GST_H264_PROFILE_BASELINE: Baseline profile (A.2.1) * @GST_H264_PROFILE_BASELINE: Baseline profile (A.2.1)
* @GST_H264_PROFILE_MAIN: Main profile (A.2.2) * @GST_H264_PROFILE_MAIN: Main profile (A.2.2)
* @GST_H264_PROFILE_EXTENDED: Extended profile (A.2.3) * @GST_H264_PROFILE_EXTENDED: Extended profile (A.2.3)

View File

@ -144,7 +144,7 @@ typedef enum {
} GstMpeg4VideoObjectCodingType; } GstMpeg4VideoObjectCodingType;
/** /**
* GstMpeg4ChromaFormat * GstMpeg4ChromaFormat:
* *
* The chroma format in use as * The chroma format in use as
* defined in: Table 6-13 -- Meaning of chroma_format * defined in: Table 6-13 -- Meaning of chroma_format
@ -248,6 +248,8 @@ struct _GstMpeg4VisualObjectSequence {
}; };
/** /**
* GstMpeg4VisualObject:
*
* The visual object structure as defined in: * The visual object structure as defined in:
* 6.2.2 Visual Object Sequence and Visual Object * 6.2.2 Visual Object Sequence and Visual Object
*/ */

View File

@ -384,7 +384,6 @@ struct _GstMpegVideoGop
/** /**
* GstMpegVideoTypeOffsetSize: * GstMpegVideoTypeOffsetSize:
*
* @type: the type of the packet that start at @offset * @type: the type of the packet that start at @offset
* @data: the data containing the packet starting at @offset * @data: the data containing the packet starting at @offset
* @offset: the offset of the packet start in bytes, it is the exact, start of the packet, no sync code included * @offset: the offset of the packet start in bytes, it is the exact, start of the packet, no sync code included
@ -403,7 +402,7 @@ struct _GstMpegVideoPacket
gboolean gst_mpeg_video_parse (GstMpegVideoPacket * packet, gboolean gst_mpeg_video_parse (GstMpegVideoPacket * packet,
const guint8 * data, gsize size, guint offset); const guint8 * data, gsize size, guint offset);
gboolean gst_mpeg_video_parse_sequence_header (GstMpegVideoSequenceHdr * params, gboolean gst_mpeg_video_parse_sequence_header (GstMpegVideoSequenceHdr * seqhdr,
const guint8 * data, gsize size, guint offset); const guint8 * data, gsize size, guint offset);
/* seqext and displayext may be NULL if not received */ /* seqext and displayext may be NULL if not received */

View File

@ -1674,8 +1674,7 @@ gst_vc1_identify_next_bdu (const guint8 * data, gsize size, GstVC1BDU * bdu)
g_return_val_if_fail (bdu != NULL, GST_VC1_PARSER_ERROR); g_return_val_if_fail (bdu != NULL, GST_VC1_PARSER_ERROR);
if (size < 4) { if (size < 4) {
GST_DEBUG ("Can't parse, buffer has too small size %" G_GSIZE_FORMAT, GST_DEBUG ("Can't parse, buffer has too small size %" G_GSIZE_FORMAT, size);
size);
return GST_VC1_PARSER_ERROR; return GST_VC1_PARSER_ERROR;
} }
@ -1718,7 +1717,7 @@ gst_vc1_identify_next_bdu (const guint8 * data, gsize size, GstVC1BDU * bdu)
* gst_vc1_parse_sequence_layer: * gst_vc1_parse_sequence_layer:
* @data: The data to parse * @data: The data to parse
* @size: the size of @data * @size: the size of @data
* @structa: The #GstVC1SeqLayer to set. * @seqlayer: The #GstVC1SeqLayer to set.
* *
* Parses @data, and fills @seqlayer fields. * Parses @data, and fills @seqlayer fields.
* *
@ -1792,7 +1791,7 @@ gst_vc1_parse_sequence_header_struct_a (const guint8 * data,
* gst_vc1_parse_sequence_header_struct_b: * gst_vc1_parse_sequence_header_struct_b:
* @data: The data to parse * @data: The data to parse
* @size: the size of @data * @size: the size of @data
* @structa: The #GstVC1SeqStructB to set. * @structb: The #GstVC1SeqStructB to set.
* *
* Parses @data, and fills @structb fields. * Parses @data, and fills @structb fields.
* *
@ -2098,7 +2097,6 @@ failed:
/** /**
* gst_vc1_bitplanes_new: * gst_vc1_bitplanes_new:
* @seqhdr: The #GstVC1SeqHdr from which to set @bitplanes
* *
* Creates a new #GstVC1BitPlanes. It should be freed with * Creates a new #GstVC1BitPlanes. It should be freed with
* gst_vc1_bitplanes_free() after use. * gst_vc1_bitplanes_free() after use.

View File

@ -34,7 +34,8 @@ G_BEGIN_DECLS
#define MAX_HRD_NUM_LEAKY_BUCKETS 31 #define MAX_HRD_NUM_LEAKY_BUCKETS 31
/** /**
* @GST_VC1_BFRACTION_BASIS: The @bfraction variable should be divided * GST_VC1_BFRACTION_BASIS:
* The @bfraction variable should be divided
* by this constant to have the actual value. * by this constant to have the actual value.
*/ */
#define GST_VC1_BFRACTION_BASIS 840 #define GST_VC1_BFRACTION_BASIS 840