[cleanup] Various style and cleanups

Various fixes for gtk-doc warnings and making functions without
arguments take void as parameter.
This commit is contained in:
Benjamin Otte 2010-01-20 13:30:48 +01:00
parent 665a06a44e
commit 89d9aaee48
9 changed files with 34 additions and 26 deletions

View File

@ -90,7 +90,7 @@ static GstPlugin *gst_lv2_plugin;
GST_DEBUG_CATEGORY_STATIC (lv2_debug); GST_DEBUG_CATEGORY_STATIC (lv2_debug);
#define GST_CAT_DEFAULT lv2_debug #define GST_CAT_DEFAULT lv2_debug
/** Convert an LV2 port role to a Gst channel positon /* Convert an LV2 port role to a Gst channel positon
* WARNING: If the group has only a single port, * WARNING: If the group has only a single port,
* GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER will be returned for pg:centerRole * GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER will be returned for pg:centerRole
* (which is used by LV2 for mono groups), but this is not correct. In this * (which is used by LV2 for mono groups), but this is not correct. In this
@ -139,7 +139,7 @@ gst_lv2_role_to_position (SLV2Value role)
return GST_AUDIO_CHANNEL_POSITION_INVALID; return GST_AUDIO_CHANNEL_POSITION_INVALID;
} }
/** Find and return the group @a uri in @a groups, or NULL if not found */ /* Find and return the group @a uri in @a groups, or NULL if not found */
static GstLV2Group * static GstLV2Group *
gst_lv2_class_find_group (GArray * groups, SLV2Value uri) gst_lv2_class_find_group (GArray * groups, SLV2Value uri)
{ {

View File

@ -52,9 +52,9 @@ typedef struct _GstTheoraExpDecClass GstTheoraExpDecClass;
*/ */
struct _GstTheoraExpDec struct _GstTheoraExpDec
{ {
/* <private> */
GstElement element; GstElement element;
/* <private> */
/* Pads */ /* Pads */
GstPad *sinkpad; GstPad *sinkpad;
GstPad *srcpad; GstPad *srcpad;

View File

@ -47,6 +47,7 @@ typedef struct _GstZBarClass GstZBarClass;
*/ */
struct _GstZBar struct _GstZBar
{ {
/*< private >*/
GstVideoFilter videofilter; GstVideoFilter videofilter;
/* format */ /* format */

View File

@ -689,9 +689,9 @@ gst_asf_mux_write_file_properties (GstAsfMux * asfmux, guint8 ** buf)
/** /**
* gst_asf_mux_write_stream_properties: * gst_asf_mux_write_stream_properties:
* @param asfmux: * @asfmux:
* @param buf: pointer to the data pointer * @buf: pointer to the data pointer
* @param asfpad: Pad that handles the stream * @asfpad: Pad that handles the stream
* *
* Writes the stream properties object in the buffer * Writes the stream properties object in the buffer
* for the stream handled by the #GstAsfPad passed. * for the stream handled by the #GstAsfPad passed.

View File

@ -64,7 +64,7 @@ const Guid guids[] = {
* Returns: The generated GUID * Returns: The generated GUID
*/ */
Guid Guid
gst_asf_generate_file_id () gst_asf_generate_file_id (void)
{ {
guint32 aux; guint32 aux;
Guid guid; Guid guid;
@ -168,11 +168,13 @@ gst_asf_get_var_size_field_len (guint8 field_type)
/** /**
* gst_asf_file_info_new: * gst_asf_file_info_new:
*
* Creates a new #GstAsfFileInfo * Creates a new #GstAsfFileInfo
*
* Returns: the created struct * Returns: the created struct
*/ */
GstAsfFileInfo * GstAsfFileInfo *
gst_asf_file_info_new () gst_asf_file_info_new (void)
{ {
return g_new0 (GstAsfFileInfo, 1); return g_new0 (GstAsfFileInfo, 1);
} }
@ -180,6 +182,7 @@ gst_asf_file_info_new ()
/** /**
* gst_asf_file_info_reset: * gst_asf_file_info_reset:
* @info: the #GstAsfFileInfo to be reset * @info: the #GstAsfFileInfo to be reset
*
* resets the data of a #GstFileInfo * resets the data of a #GstFileInfo
*/ */
void void
@ -237,7 +240,7 @@ gst_asf_payload_free (AsfPayload * payload)
* Returns: * Returns:
*/ */
guint64 guint64
gst_asf_get_current_time () gst_asf_get_current_time (void)
{ {
GTimeVal timeval; GTimeVal timeval;
guint64 secs; guint64 secs;

View File

@ -83,21 +83,21 @@ typedef struct _AsfPayload
guint16 packet_count; guint16 packet_count;
} AsfPayload; } AsfPayload;
Guid gst_asf_generate_file_id (); Guid gst_asf_generate_file_id (void);
gboolean gst_byte_reader_get_asf_var_size_field (GstByteReader * reader, gboolean gst_byte_reader_get_asf_var_size_field (GstByteReader * reader,
guint8 field_type, guint32 * var); guint8 field_type, guint32 * var);
guint32 gst_asf_read_var_size_field (guint8 * data, guint8 field_type); guint32 gst_asf_read_var_size_field (guint8 * data, guint8 field_type);
guint gst_asf_get_var_size_field_len (guint8 field_type); guint gst_asf_get_var_size_field_len (guint8 field_type);
GstAsfFileInfo *gst_asf_file_info_new (); GstAsfFileInfo *gst_asf_file_info_new (void);
void gst_asf_file_info_reset (GstAsfFileInfo * info); void gst_asf_file_info_reset (GstAsfFileInfo * info);
void gst_asf_file_info_free (GstAsfFileInfo * info); void gst_asf_file_info_free (GstAsfFileInfo * info);
guint32 gst_asf_payload_get_size (AsfPayload * payload); guint32 gst_asf_payload_get_size (AsfPayload * payload);
void gst_asf_payload_free (AsfPayload * payload); void gst_asf_payload_free (AsfPayload * payload);
guint64 gst_asf_get_current_time (); guint64 gst_asf_get_current_time (void);
gboolean gst_asf_match_guid (const guint8 * data, const Guid * g); gboolean gst_asf_match_guid (const guint8 * data, const Guid * g);

View File

@ -42,7 +42,7 @@
#include "descriptors.h" #include "descriptors.h"
/** /*
* Some mp4 structures (descriptors) use a coding scheme for * Some mp4 structures (descriptors) use a coding scheme for
* representing its size. * representing its size.
* It is grouped in bytes. The 1st bit set to 1 means we need another byte, * It is grouped in bytes. The 1st bit set to 1 means we need another byte,
@ -51,7 +51,7 @@
* The next set of functions handle those values * The next set of functions handle those values
*/ */
/** /*
* Gets an unsigned integer and packs it into a 'expandable size' format * Gets an unsigned integer and packs it into a 'expandable size' format
* (as used by mp4 descriptors) * (as used by mp4 descriptors)
* @size: the integer to be parsed * @size: the integer to be parsed
@ -70,7 +70,7 @@ expandable_size_parse (guint64 size, guint8 * ptr, guint32 array_size)
} }
} }
/** /*
* Gets how many positions in an array holding an 'expandable size' * Gets how many positions in an array holding an 'expandable size'
* are really used * are really used
* *
@ -112,7 +112,7 @@ desc_dec_specific_info_init (DecoderSpecificInfoDescriptor * dsid)
} }
DecoderSpecificInfoDescriptor * DecoderSpecificInfoDescriptor *
desc_dec_specific_info_new () desc_dec_specific_info_new (void)
{ {
DecoderSpecificInfoDescriptor *desc = DecoderSpecificInfoDescriptor *desc =
g_new0 (DecoderSpecificInfoDescriptor, 1); g_new0 (DecoderSpecificInfoDescriptor, 1);
@ -151,7 +151,7 @@ desc_es_init (ESDescriptor * es)
} }
ESDescriptor * ESDescriptor *
desc_es_descriptor_new () desc_es_descriptor_new (void)
{ {
ESDescriptor *es = g_new0 (ESDescriptor, 1); ESDescriptor *es = g_new0 (ESDescriptor, 1);

View File

@ -138,12 +138,12 @@ typedef struct _ESDescriptor
/* --- FUNCTIONS --- */ /* --- FUNCTIONS --- */
void desc_es_init (ESDescriptor *es); void desc_es_init (ESDescriptor *es);
ESDescriptor *desc_es_descriptor_new (); ESDescriptor *desc_es_descriptor_new (void);
guint64 desc_es_descriptor_copy_data (ESDescriptor *es, guint8 **buffer, guint64 desc_es_descriptor_copy_data (ESDescriptor *es, guint8 **buffer,
guint64 *size, guint64 *offset); guint64 *size, guint64 *offset);
void desc_es_descriptor_clear (ESDescriptor *es); void desc_es_descriptor_clear (ESDescriptor *es);
DecoderSpecificInfoDescriptor *desc_dec_specific_info_new(); DecoderSpecificInfoDescriptor *desc_dec_specific_info_new(void);
void desc_dec_specific_info_free (DecoderSpecificInfoDescriptor *dsid); void desc_dec_specific_info_free (DecoderSpecificInfoDescriptor *dsid);
void desc_dec_specific_info_alloc_data (DecoderSpecificInfoDescriptor *dsid, void desc_dec_specific_info_alloc_data (DecoderSpecificInfoDescriptor *dsid,
guint32 size); guint32 size);

View File

@ -142,14 +142,15 @@ prop_copy_fourcc (guint32 prop, guint8 ** buffer, guint64 * size,
INT_ARRAY_COPY_FUNC (fourcc, guint32); INT_ARRAY_COPY_FUNC (fourcc, guint32);
/** /**
* Copies a string of bytes without placing its size at the beginning. * prop_copy_fixed_size_string:
*
* @string: the string to be copied * @string: the string to be copied
* @str_size: size of the string * @str_size: size of the string
* @buffer: the array to copy the string to * @buffer: the array to copy the string to
* @offset: the position in the buffer array. * @offset: the position in the buffer array.
* This value is updated to the point right after the copied string. * This value is updated to the point right after the copied string.
* *
* Copies a string of bytes without placing its size at the beginning.
*
* Returns: the number of bytes copied * Returns: the number of bytes copied
*/ */
guint64 guint64
@ -160,9 +161,7 @@ prop_copy_fixed_size_string (guint8 * string, guint str_size, guint8 ** buffer,
} }
/** /**
* Copies a string and its size to an array. Example: * prop_copy_size_string:
* string = 'abc\0'
* result in the array: [3][a][b][c] (each [x] represents a position)
* *
* @string: the string to be copied * @string: the string to be copied
* @str_size: size of the string * @str_size: size of the string
@ -170,6 +169,10 @@ prop_copy_fixed_size_string (guint8 * string, guint str_size, guint8 ** buffer,
* @offset: the position in the buffer array. * @offset: the position in the buffer array.
* This value is updated to the point right after the copied string. * This value is updated to the point right after the copied string.
* *
* Copies a string and its size to an array. Example:
* string = 'abc\0'
* result in the array: [3][a][b][c] (each [x] represents a position)
*
* Returns: the number of bytes copied * Returns: the number of bytes copied
*/ */
guint64 guint64
@ -184,13 +187,14 @@ prop_copy_size_string (guint8 * string, guint str_size, guint8 ** buffer,
} }
/** /**
* Copies a string including its null terminating char to an array. * prop_copy_null_terminated_string:
*
* @string: the string to be copied * @string: the string to be copied
* @buffer: the array to copy the string to * @buffer: the array to copy the string to
* @offset: the position in the buffer array. * @offset: the position in the buffer array.
* This value is updated to the point right after the copied string. * This value is updated to the point right after the copied string.
* *
* Copies a string including its null terminating char to an array.
*
* Returns: the number of bytes copied * Returns: the number of bytes copied
*/ */
guint64 guint64