docs: fix "Symbol name not found at the start of the comment block"

Add symbols or change comment into a regular comment.
This commit is contained in:
Stefan Sauer 2015-07-07 16:59:20 +02:00
parent 093e8f8a75
commit 12930c2f8c
6 changed files with 13 additions and 11 deletions

View file

@ -50,7 +50,7 @@
#include <gst/tag/tag.h> #include <gst/tag/tag.h>
#include <gst/video/video.h> #include <gst/video/video.h>
/** /*
* Creates a new AtomsContext for the given flavor. * Creates a new AtomsContext for the given flavor.
*/ */
AtomsContext * AtomsContext *
@ -61,7 +61,7 @@ atoms_context_new (AtomsTreeFlavor flavor)
return context; return context;
} }
/** /*
* Frees an AtomsContext and all memory associated with it * Frees an AtomsContext and all memory associated with it
*/ */
void void

View file

@ -112,7 +112,7 @@ void atoms_context_free (AtomsContext *context);
/* atom defs and functions */ /* atom defs and functions */
/** /*
* Used for storing time related values for some atoms. * Used for storing time related values for some atoms.
*/ */
typedef struct _TimeInfo typedef struct _TimeInfo

View file

@ -40,7 +40,7 @@
* SOFTWARE. * SOFTWARE.
*/ */
/** /*
* This module contains functions for serializing partial information from * This module contains functions for serializing partial information from
* a mux in progress (by qtmux elements). This enables reconstruction of the * a mux in progress (by qtmux elements). This enables reconstruction of the
* moov box if a crash happens and thus recovering the movie file. * moov box if a crash happens and thus recovering the movie file.
@ -128,7 +128,7 @@ atoms_recov_write_ftyp_info (FILE * f, AtomFTYP * ftyp, GstBuffer * prefix)
return TRUE; return TRUE;
} }
/** /*
* Writes important info on the 'moov' atom (non-trak related) * Writes important info on the 'moov' atom (non-trak related)
* to be able to recover the moov structure after a crash. * to be able to recover the moov structure after a crash.
* *
@ -153,7 +153,7 @@ atoms_recov_write_moov_info (FILE * f, AtomMOOV * moov)
return atom_size > 0 && writen == atom_size; return atom_size > 0 && writen == atom_size;
} }
/** /*
* Writes the number of traks to the file. * Writes the number of traks to the file.
* This simply writes a guint32 in BE. * This simply writes a guint32 in BE.
*/ */
@ -165,7 +165,7 @@ atoms_recov_write_traks_number (FILE * f, guint32 traks)
return fwrite (data, 4, 1, f) == 1; return fwrite (data, 4, 1, f) == 1;
} }
/** /*
* Writes the moov's timescale to the file * Writes the moov's timescale to the file
* This simply writes a guint32 in BE. * This simply writes a guint32 in BE.
*/ */
@ -177,7 +177,7 @@ atoms_recov_write_moov_timescale (FILE * f, guint32 timescale)
return fwrite (data, 4, 1, f) == 1; return fwrite (data, 4, 1, f) == 1;
} }
/** /*
* Writes the trak atom to the file. * Writes the trak atom to the file.
*/ */
gboolean gboolean
@ -778,7 +778,7 @@ trak_recov_data_add_sample (TrakRecovData * trak, TrakBufferEntryInfo * b)
b->chunk_offset, b->sync, b->pts_offset); b->chunk_offset, b->sync, b->pts_offset);
} }
/** /*
* Parses the buffer entries in the MoovRecovFile and matches the inputs * Parses the buffer entries in the MoovRecovFile and matches the inputs
* with the data in the MdatRecovFile. Whenever a buffer entry of that * with the data in the MdatRecovFile. Whenever a buffer entry of that
* represents 'x' bytes of data, the same amount of data is 'validated' in * represents 'x' bytes of data, the same amount of data is 'validated' in

View file

@ -46,7 +46,7 @@
#include <glib.h> #include <glib.h>
#include <string.h> #include <string.h>
/** /*
* Functions for copying atoms properties. * Functions for copying atoms properties.
* *
* All of them receive, as the input, the property to be copied, the destination * All of them receive, as the input, the property to be copied, the destination

View file

@ -341,7 +341,7 @@ gst_matroska_mux_class_init (GstMatroskaMuxClass * klass)
parent_class = g_type_class_peek_parent (klass); parent_class = g_type_class_peek_parent (klass);
} }
/** /*
* Start of pad option handler code * Start of pad option handler code
*/ */
#define DEFAULT_PAD_FRAME_DURATION TRUE #define DEFAULT_PAD_FRAME_DURATION TRUE

View file

@ -1803,6 +1803,7 @@ rtp_source_has_retained (RTPSource * src, GCompareFunc func, gconstpointer data)
} }
/** /**
* rtp_source_register_nack:
* @src: The #RTPSource * @src: The #RTPSource
* @seqnum: a seqnum * @seqnum: a seqnum
* *
@ -1850,6 +1851,7 @@ rtp_source_register_nack (RTPSource * src, guint16 seqnum)
} }
/** /**
* rtp_source_get_nacks:
* @src: The #RTPSource * @src: The #RTPSource
* @n_nacks: result number of nacks * @n_nacks: result number of nacks
* *