mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-03 04:52:28 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs/plugins/: Fix up docs for taglib plugin

Browse source 
Original commit message from CVS:

* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-decl-list.txt:
* docs/plugins/gst-plugins-bad-plugins-decl.txt:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins-undocumented.txt:
Fix up docs for taglib plugin
Also scan .cc files
This commit is contained in:
Thomas Vander Stichele 2006-04-30 14:58:29 +00:00
parent abc3a576fb
commit 941274f57c
7 changed files with 83 additions and 106 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
ChangeLog
View file

@ -1,3 +1,14 @@
2006-04-30 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-decl-list.txt:
* docs/plugins/gst-plugins-bad-plugins-decl.txt:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins-undocumented.txt:
Fix up docs for taglib plugin
Also scan .cc files
2006-04-29 Tim-Philipp Müller <tim at centricular dot net> 2006-04-29 Tim-Philipp Müller <tim at centricular dot net>
* ext/taglib/gsttaglib.cc: * ext/taglib/gsttaglib.cc:

2
docs/plugins/Makefile.am
View file

@ -50,7 +50,7 @@ SCAN_OPTIONS=
#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE) #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
# Extra options to supply to gtkdoc-mkdb. # Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc
# Extra options to supply to gtkdoc-fixref. # Extra options to supply to gtkdoc-fixref.
# FIXME get the location of the installed gstreamer docs # FIXME get the location of the installed gstreamer docs

21
docs/plugins/gst-plugins-bad-plugins-decl-list.txt
View file

@ -18,23 +18,22 @@ GST_IS_DFBVIDEOSINK_CLASS
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>ximagesrc</FILE> <FILE>gstid3v2mux</FILE>
<TITLE>GstXImageSrc</TITLE> GstId3v2Mux
GstXImageSrc GstId3v2MuxClass
<SUBSECTION Standard> <SUBSECTION Standard>
GST_XIMAGESRC GST_ID3V2_MUX
GST_IS_XIMAGESRC GST_IS_ID3V2_MUX
GST_TYPE_XIMAGESRC GST_TYPE_ID3V2_MUX
gst_ximagesrc_get_type gst_id3v2_mux_get_type
GST_XIMAGESRC_CLASS GST_ID3V2_MUX_CLASS
GST_IS_XIMAGESRC_CLASS GST_IS_ID3V2_MUX_CLASS
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gsttaglib</FILE> <FILE>gsttaglib</FILE>
GstTagLibMuxPriv
<TITLE>GstTagLibMux</TITLE>
GstTagLibMux GstTagLibMux
GstTagLibMuxClass
<SUBSECTION Standard> <SUBSECTION Standard>
GST_TAG_LIB_MUX GST_TAG_LIB_MUX
GST_IS_TAG_LIB_MUX GST_IS_TAG_LIB_MUX

136
docs/plugins/gst-plugins-bad-plugins-decl.txt
View file

@ -133,97 +133,62 @@ void
<RETURNS>GType </RETURNS> <RETURNS>GType </RETURNS>
void void
</FUNCTION> </FUNCTION>
<MACRO>
<NAME>GST_TYPE_XIMAGESRC</NAME>
#define GST_TYPE_XIMAGESRC (gst_ximagesrc_get_type())
</MACRO>
<MACRO>
<NAME>GST_XIMAGESRC</NAME>
#define GST_XIMAGESRC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_XIMAGESRC,GstXImageSrc))
</MACRO>
<MACRO>
<NAME>GST_XIMAGESRC_CLASS</NAME>
#define GST_XIMAGESRC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_XIMAGESRC,GstXImageSrc))
</MACRO>
<MACRO>
<NAME>GST_IS_XIMAGESRC</NAME>
#define GST_IS_XIMAGESRC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_XIMAGESRC))
</MACRO>
<MACRO>
<NAME>GST_IS_XIMAGESRC_CLASS</NAME>
#define GST_IS_XIMAGESRC_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_XIMAGESRC))
</MACRO>
<STRUCT> <STRUCT>
<NAME>GstXImageSrc</NAME> <NAME>GstId3v2Mux</NAME>
</STRUCT> </STRUCT>
<STRUCT> <STRUCT>
<NAME>GstXImageSrcClass</NAME> <NAME>GstId3v2MuxClass</NAME>
</STRUCT> </STRUCT>
<STRUCT>
<NAME></NAME>
typedef struct _GstId3v2Mux {
GstTagLibMux taglibmux;
};
</STRUCT>
<STRUCT>
<NAME></NAME>
typedef struct _GstId3v2MuxClass {
GstTagLibMuxClass taglibmux_class;
};
</STRUCT>
<MACRO>
<NAME>GST_TYPE_ID3V2_MUX</NAME>
#define GST_TYPE_ID3V2_MUX \
(gst_id3v2_mux_get_type())
</MACRO>
<MACRO>
<NAME>GST_ID3V2_MUX</NAME>
#define GST_ID3V2_MUX(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ID3V2_MUX,GstId3v2Mux))
</MACRO>
<MACRO>
<NAME>GST_ID3V2_MUX_CLASS</NAME>
#define GST_ID3V2_MUX_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ID3V2_MUX,GstId3v2MuxClass))
</MACRO>
<MACRO>
<NAME>GST_IS_ID3V2_MUX</NAME>
#define GST_IS_ID3V2_MUX(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ID3V2_MUX))
</MACRO>
<MACRO>
<NAME>GST_IS_ID3V2_MUX_CLASS</NAME>
#define GST_IS_ID3V2_MUX_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ID3V2_MUX))
</MACRO>
<FUNCTION> <FUNCTION>
<NAME>gst_ximagesrc_get_type</NAME> <NAME>gst_id3v2_mux_get_type</NAME>
<RETURNS>GType </RETURNS> <RETURNS>GType </RETURNS>
void void
</FUNCTION> </FUNCTION>
<STRUCT> <STRUCT>
<NAME>GstXImageSrc</NAME>
struct _GstXImageSrc
{
GstPushSrc parent;
/* Information on display */
GstXContext *xcontext;
gint width;
gint height;
Window xwindow;
gchar *display_name;
guint screen_num;
/* Desired output framerate */
gint fps_n;
gint fps_d;
/* for framerate sync */
GstClockID clock_id;
gint64 last_frame_no;
/* Protect X Windows calls */
GMutex *x_lock;
/* Gathered pool of emitted buffers */
GMutex *pool_lock;
GSList *buffer_pool;
/* XFixes and XDamage support */
gboolean have_xfixes;
gboolean have_xdamage;
gboolean show_pointer;
#ifdef HAVE_XFIXES
int fixes_event_base;
XFixesCursorImage *cursor_image;
#endif
#ifdef HAVE_XDAMAGE
Damage damage;
int damage_event_base;
XserverRegion damage_region;
GC damage_copy_gc;
#endif
};
</STRUCT>
<STRUCT>
<NAME>GstXImageSrcClass</NAME>
struct _GstXImageSrcClass
{
GstPushSrcClass parent_class;
};
</STRUCT>
<STRUCT>
<NAME>GstTagLibMuxPriv</NAME>
</STRUCT>
<STRUCT>
<NAME>GstTagLibMux</NAME> <NAME>GstTagLibMux</NAME>
</STRUCT>
<STRUCT>
<NAME>GstTagLibMuxClass</NAME>
</STRUCT>
<STRUCT>
<NAME></NAME>
typedef struct _GstTagLibMux { typedef struct _GstTagLibMux {
GstElement element; GstElement element;
@ -234,13 +199,16 @@ typedef struct _GstTagLibMux {
gboolean render_tag; gboolean render_tag;
GstEvent *newsegment_ev; /* cached newsegment event from upstream */ GstEvent *newsegment_ev; /* cached newsegment event from upstream */
} GstTagLibMux; };
</STRUCT> </STRUCT>
<STRUCT> <STRUCT>
<NAME>GstTagLibMuxClass</NAME> <NAME></NAME>
typedef struct _GstTagLibMuxClass { typedef struct _GstTagLibMuxClass {
GstElementClass parent_class; GstElementClass parent_class;
} GstTagLibMuxClass;
/* vfuncs */
GstBuffer * (*render_tag) (GstTagLibMux * mux, GstTagList * tag_list);
};
</STRUCT> </STRUCT>
<MACRO> <MACRO>
<NAME>GST_TYPE_TAG_LIB_MUX</NAME> <NAME>GST_TYPE_TAG_LIB_MUX</NAME>

2
docs/plugins/gst-plugins-bad-plugins-docs.sgml
View file

@ -14,7 +14,7 @@
<title>gst-plugins-bad Elements</title> <title>gst-plugins-bad Elements</title>
<xi:include href="xml/element-dfbvideosink.xml" /> <xi:include href="xml/element-dfbvideosink.xml" />
<xi:include href="xml/element-tagid3v2mux.xml" /> <xi:include href="xml/element-id3v2mux.xml" />
</chapter> </chapter>
<chapter> <chapter>

8
docs/plugins/gst-plugins-bad-plugins-sections.txt
View file

@ -7,10 +7,10 @@ GstDfbVideoSinkClass
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>element-tagid3v2mux</FILE> <FILE>element-id3v2mux</FILE>
GstTagLibMux GstId3v2Mux
<TITLE>tagid3v2mux</TITLE> <TITLE>id3v2mux</TITLE>
<SUBSECTION Standard> <SUBSECTION Standard>
GstTagLibMuxClass GstId3v2MuxClass
</SECTION> </SECTION>

9
docs/plugins/gst-plugins-bad-plugins-undocumented.txt
View file

@ -1,10 +1,9 @@
83% symbol docs coverage. 92% symbol docs coverage.
10 symbols documented. 11 symbols documented.
0 symbols incomplete. 0 symbols incomplete.
2 not documented. 1 not documented.
GstTagLibMux GstId3v2Mux
element-tagid3v2mux:Short_Description