[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 committed by Tim-Philipp Müller
parent 33bf180eaa
commit 6569e9587c
3 changed files with 18 additions and 14 deletions

View file

@ -42,7 +42,7 @@
#include "descriptors.h"
/**
/*
* Some mp4 structures (descriptors) use a coding scheme for
* representing its size.
* 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
*/
/**
/*
* Gets an unsigned integer and packs it into a 'expandable size' format
* (as used by mp4 descriptors)
* @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'
* are really used
*
@ -112,7 +112,7 @@ desc_dec_specific_info_init (DecoderSpecificInfoDescriptor * dsid)
}
DecoderSpecificInfoDescriptor *
desc_dec_specific_info_new ()
desc_dec_specific_info_new (void)
{
DecoderSpecificInfoDescriptor *desc =
g_new0 (DecoderSpecificInfoDescriptor, 1);
@ -151,7 +151,7 @@ desc_es_init (ESDescriptor * es)
}
ESDescriptor *
desc_es_descriptor_new ()
desc_es_descriptor_new (void)
{
ESDescriptor *es = g_new0 (ESDescriptor, 1);

View file

@ -138,12 +138,12 @@ typedef struct _ESDescriptor
/* --- FUNCTIONS --- */
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 *size, guint64 *offset);
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_alloc_data (DecoderSpecificInfoDescriptor *dsid,
guint32 size);

View file

@ -142,14 +142,15 @@ prop_copy_fourcc (guint32 prop, guint8 ** buffer, guint64 * size,
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
* @str_size: size of the string
* @buffer: the array to copy the string to
* @offset: the position in the buffer array.
* 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
*/
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:
* string = 'abc\0'
* result in the array: [3][a][b][c] (each [x] represents a position)
* prop_copy_size_string:
*
* @string: the string to be copied
* @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.
* 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
*/
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
* @buffer: the array to copy the string to
* @offset: the position in the buffer array.
* 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
*/
guint64