diff options
author | Edgard Lima <edgard.lima@indt.org.br> | 2008-01-25 17:45:28 +0000 |
---|---|---|
committer | Edgard Lima <edgard.lima@indt.org.br> | 2008-01-25 17:45:28 +0000 |
commit | 9e31b57dc37cb94761ab3aa98018c6f9bc496e0c (patch) | |
tree | 3f9470e0fef203014f017eb35a06b1da3426ed53 /ext/metadata/metadatatypes.h | |
parent | ef421fee72539e6202c8535687f15da2c3d4d1a7 (diff) | |
download | gst-plugins-bad-9e31b57dc37cb94761ab3aa98018c6f9bc496e0c.tar.gz gst-plugins-bad-9e31b57dc37cb94761ab3aa98018c6f9bc496e0c.tar.bz2 gst-plugins-bad-9e31b57dc37cb94761ab3aa98018c6f9bc496e0c.zip |
Add lot of documentation.
Original commit message from CVS:
Add lot of documentation.
Diffstat (limited to 'ext/metadata/metadatatypes.h')
-rw-r--r-- | ext/metadata/metadatatypes.h | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/ext/metadata/metadatatypes.h b/ext/metadata/metadatatypes.h index d58d23b4..fd7df9dd 100644 --- a/ext/metadata/metadatatypes.h +++ b/ext/metadata/metadatatypes.h @@ -44,10 +44,18 @@ #ifndef __METADATATYPES_H__ #define __METADATATYPES_H__ +/* + * includes + */ + #include <glib.h> G_BEGIN_DECLS +/* + * enum and types + */ + /* *INDENT-OFF* */ typedef enum _tag_MetadataParsingReturn { @@ -78,10 +86,14 @@ typedef struct _tag_MetadataChunk typedef struct _tag_MetadataChunkArray { MetadataChunk * chunk; - gsize len; - gsize allocated_len; + gsize len; /* number of chunks into aray */ + gsize allocated_len; /* number of slots into the array to store chunks */ } MetadataChunkArray; +/* + * external function prototypes + */ + extern void metadata_chunk_array_init(MetadataChunkArray * array, gsize alloc_size); @@ -94,11 +106,9 @@ metadata_chunk_array_clear(MetadataChunkArray * array); extern void metadata_chunk_array_append(MetadataChunkArray * array, MetadataChunk * chunk); -/* sorted by offset (chunk supposed to be already sorted - * returns false if chunks are inserted in same offset - */ extern void -metadata_chunk_array_append_sorted(MetadataChunkArray * array, MetadataChunk * chunk); +metadata_chunk_array_append_sorted(MetadataChunkArray * array, + MetadataChunk * chunk); extern void metadata_chunk_array_remove_zero_size (MetadataChunkArray * array); |