diff options
author | Stefan Kost <ensonic@users.sourceforge.net> | 2005-08-30 17:23:19 +0000 |
---|---|---|
committer | Stefan Kost <ensonic@users.sourceforge.net> | 2005-08-30 17:23:19 +0000 |
commit | a44593349c05e8fe4f65ee1ca6b26120b37137ae (patch) | |
tree | 5a6ca85e2d32c75b03525ac7aefbd62f622622ac /docs | |
parent | da88afccc59bc9fa10efb6a0166c66db23c376b6 (diff) |
more docs and two more inlined
Original commit message from CVS:
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstformat.sgml:
* docs/gst/tmpl/gstversion.sgml:
* gst/gstbus.h:
* gst/gstformat.c:
* gst/gstformat.h:
* gst/gstversion.h.in:
more docs and two more inlined
Diffstat (limited to 'docs')
-rw-r--r-- | docs/gst/tmpl/.gitignore | 3 | ||||
-rw-r--r-- | docs/gst/tmpl/gstformat.sgml | 102 | ||||
-rw-r--r-- | docs/gst/tmpl/gstversion.sgml | 51 |
3 files changed, 3 insertions, 153 deletions
diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore index 9ac1756f3..12cb4b1cc 100644 --- a/docs/gst/tmpl/.gitignore +++ b/docs/gst/tmpl/.gitignore @@ -19,10 +19,13 @@ gstfakesrc.sgml gstfakesink.sgml gstfilesrc.sgml gstfilesink.sgml +gstformat.sgml gstmessage.sgml gstminiobject.sgml gstprobe.sgml gstpushsrc.sgml gstquery.sgml gsttask.sgml +gstversion.sgml gstxmlregistry.sgml + diff --git a/docs/gst/tmpl/gstformat.sgml b/docs/gst/tmpl/gstformat.sgml deleted file mode 100644 index 887834555..000000000 --- a/docs/gst/tmpl/gstformat.sgml +++ /dev/null @@ -1,102 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GstFormat - -<!-- ##### SECTION Short_Description ##### --> -Dynamically register new formats - -<!-- ##### SECTION Long_Description ##### --> -<para> -GstFormats functions are used to register a new format to the gstreamer core. -formats can be used to perform seeking or conversions/query operations. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GstPad, #GstElement -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### ENUM GstFormat ##### --> -<para> -Standard predefined formats -</para> - -@GST_FORMAT_UNDEFINED: undefined format -@GST_FORMAT_DEFAULT: the default format of the pad/element -@GST_FORMAT_BYTES: bytes -@GST_FORMAT_TIME: time in nanoseconds -@GST_FORMAT_BUFFERS: buffers -@GST_FORMAT_PERCENT: percentage of stream - -<!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### --> -<para> -The PERCENT format is between 0 and this value -</para> - - - -<!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### --> -<para> -The value used to scale down the reported PERCENT format value to -its real value. -</para> - - - -<!-- ##### STRUCT GstFormatDefinition ##### --> -<para> -A format definition -</para> - -@value: The unique id of this format -@nick: A short nick of the format -@description: A longer description of the format - -<!-- ##### FUNCTION gst_format_register ##### --> -<para> - -</para> - -@nick: -@description: -@Returns: - - -<!-- ##### FUNCTION gst_format_get_by_nick ##### --> -<para> - -</para> - -@nick: -@Returns: - - -<!-- ##### FUNCTION gst_formats_contains ##### --> -<para> - -</para> - -@formats: -@format: -@Returns: - - -<!-- ##### FUNCTION gst_format_get_details ##### --> -<para> - -</para> - -@format: -@Returns: - - -<!-- ##### FUNCTION gst_format_iterate_definitions ##### --> -<para> - -</para> - -@Returns: - - diff --git a/docs/gst/tmpl/gstversion.sgml b/docs/gst/tmpl/gstversion.sgml deleted file mode 100644 index 4a17d3cc5..000000000 --- a/docs/gst/tmpl/gstversion.sgml +++ /dev/null @@ -1,51 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GstVersion - -<!-- ##### SECTION Short_Description ##### --> -GStreamer version macros. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Use these macros e.g. when defining own plugins. -The version macros get defined by including "gst/gst.h". -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO GST_VERSION_MAJOR ##### --> -<para> -The major version of GStreamer at compile time -</para> - - - -<!-- ##### MACRO GST_VERSION_MINOR ##### --> -<para> -The minor version of GStreamer at compile time -</para> - - - -<!-- ##### MACRO GST_VERSION_MICRO ##### --> -<para> -The micro version of GStreamer at compile time -</para> - - - -<!-- ##### FUNCTION gst_version ##### --> -<para> - -</para> - -@major: -@minor: -@micro: - - |