mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-06-05 15:08:53 +00:00
backed out the change of gst.h added some comment about building docs to README
Original commit message from CVS: backed out the change of gst.h added some comment about building docs to README
This commit is contained in:
parent
8178973c41
commit
9fa85fa424
7 changed files with 17 additions and 23 deletions
18
docs/README
18
docs/README
|
@ -29,7 +29,7 @@ OVERVIEW
|
||||||
- in .fig
|
- in .fig
|
||||||
- in .png (and maybe others)
|
- in .png (and maybe others)
|
||||||
* We want to generate docs in HTML, PS and PDF
|
* We want to generate docs in HTML, PS and PDF
|
||||||
* We want to use xmlto to generate these
|
* We want to use xml to to generate these
|
||||||
|
|
||||||
CONVENTIONS
|
CONVENTIONS
|
||||||
-----------
|
-----------
|
||||||
|
@ -92,9 +92,17 @@ GTK-DOC NOTES
|
||||||
|
|
||||||
* files under CVS control:
|
* files under CVS control:
|
||||||
- Makefile.am
|
- Makefile.am
|
||||||
- gstreamer-sections.txt, gstreamer.types.in, gstreamer-docs.sgml
|
- gstreamer-sections.txt
|
||||||
|
describes which symbols later appear on one api-doc page
|
||||||
|
configure which symbols are shown/invisible/private
|
||||||
|
- gstreamer.types
|
||||||
|
the types file lists all get_type() functions that register the GObject types
|
||||||
|
- gstreamer-docs.sgml
|
||||||
|
defines the overall structure of the api documentation
|
||||||
- tmpl/
|
- tmpl/
|
||||||
(FIXME: describe what each of these files do)
|
- only add the file to CVS if you have at least filled the short description
|
||||||
|
(filename corresponds to the <FILE> tag in the sections file)
|
||||||
|
- document as much as possible in the source (*.c files)
|
||||||
|
|
||||||
* what to do when adding a new piece of API:
|
* what to do when adding a new piece of API:
|
||||||
- add both an entity and use the entity in gstreamer-docs.sgml
|
- add both an entity and use the entity in gstreamer-docs.sgml
|
||||||
|
@ -122,8 +130,8 @@ GTK-DOC NOTES
|
||||||
- Warning: multiple "IDs" for constraint linkend: gst-tag-register.
|
- Warning: multiple "IDs" for constraint linkend: gst-tag-register.
|
||||||
- check if gst_tag_register is listed more than once in -sections.txt
|
- check if gst_tag_register is listed more than once in -sections.txt
|
||||||
|
|
||||||
WBSITE DOCUMENTATION
|
WEBSITE DOCUMENTATION
|
||||||
====================
|
=====================
|
||||||
|
|
||||||
Updating the online documentation is pretty simple.
|
Updating the online documentation is pretty simple.
|
||||||
Make sure that you
|
Make sure that you
|
||||||
|
|
|
@ -44,9 +44,6 @@
|
||||||
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
||||||
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
||||||
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
||||||
<!-- these are elements without API docs
|
|
||||||
...
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
||||||
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
||||||
|
@ -101,9 +98,6 @@ with some more specialized elements.</para>
|
||||||
&GstPluginFeature;
|
&GstPluginFeature;
|
||||||
&GstProbe;
|
&GstProbe;
|
||||||
&GstQuery;
|
&GstQuery;
|
||||||
<!-- no API docs
|
|
||||||
...
|
|
||||||
-->
|
|
||||||
&GstQueue;
|
&GstQueue;
|
||||||
&GstRegistry;
|
&GstRegistry;
|
||||||
&GstRegistryPool;
|
&GstRegistryPool;
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>gstbin</FILE>
|
<FILE>gstbin</FILE>
|
||||||
GST_BIN_CLASS
|
|
||||||
GstBinFlags
|
GstBinFlags
|
||||||
<TITLE>GstBin</TITLE>
|
<TITLE>GstBin</TITLE>
|
||||||
gst_bin_new
|
gst_bin_new
|
||||||
|
@ -24,6 +23,7 @@ GST_BIN
|
||||||
GST_IS_BIN
|
GST_IS_BIN
|
||||||
GST_TYPE_BIN
|
GST_TYPE_BIN
|
||||||
gst_bin_get_type
|
gst_bin_get_type
|
||||||
|
GST_BIN_CLASS
|
||||||
GST_IS_BIN_CLASS
|
GST_IS_BIN_CLASS
|
||||||
GST_BIN_GET_CLASS
|
GST_BIN_GET_CLASS
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
#include <gst/gst.h>
|
#include <gst/gst.h>
|
||||||
|
#include <gst/gstqueue.h>
|
||||||
|
|
||||||
gst_object_get_type
|
gst_object_get_type
|
||||||
gst_element_get_type
|
gst_element_get_type
|
||||||
|
@ -18,4 +19,3 @@ gst_index_get_type
|
||||||
gst_index_factory_get_type
|
gst_index_factory_get_type
|
||||||
gst_xml_get_type
|
gst_xml_get_type
|
||||||
gst_queue_get_type
|
gst_queue_get_type
|
||||||
gst_xml_registry_get_type
|
|
||||||
|
|
|
@ -55,14 +55,6 @@ clock providers in the bin.
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### MACRO GST_BIN_CLASS ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@klass:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### ENUM GstBinFlags ##### -->
|
<!-- ##### ENUM GstBinFlags ##### -->
|
||||||
<para>
|
<para>
|
||||||
Flags for a bin.
|
Flags for a bin.
|
||||||
|
|
|
@ -124,6 +124,8 @@ and gst_element_set_clock(). You can wait for the clock to reach a given
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@:
|
||||||
|
|
||||||
@gstelement: the object which received the signal.
|
@gstelement: the object which received the signal.
|
||||||
|
|
||||||
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
|
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
|
||||||
|
|
|
@ -47,7 +47,6 @@
|
||||||
#include <gst/gstpad.h>
|
#include <gst/gstpad.h>
|
||||||
#include <gst/gstpipeline.h>
|
#include <gst/gstpipeline.h>
|
||||||
#include <gst/gstplugin.h>
|
#include <gst/gstplugin.h>
|
||||||
#include <gst/gstqueue.h>
|
|
||||||
#include <gst/gstscheduler.h>
|
#include <gst/gstscheduler.h>
|
||||||
#include <gst/gststructure.h>
|
#include <gst/gststructure.h>
|
||||||
#include <gst/gstsystemclock.h>
|
#include <gst/gstsystemclock.h>
|
||||||
|
@ -65,7 +64,6 @@
|
||||||
#include <gst/gstparse.h>
|
#include <gst/gstparse.h>
|
||||||
#include <gst/gstregistry.h>
|
#include <gst/gstregistry.h>
|
||||||
#include <gst/gstregistrypool.h>
|
#include <gst/gstregistrypool.h>
|
||||||
#include <gst/registries/gstxmlregistry.h>
|
|
||||||
|
|
||||||
/* API compatibility stuff */
|
/* API compatibility stuff */
|
||||||
#include <gst/gstcompat.h>
|
#include <gst/gstcompat.h>
|
||||||
|
|
Loading…
Reference in a new issue