Commit graph

49 commits

Author SHA1 Message Date
Thomas Vander Stichele f1a720a4cb removing added dirs
Original commit message from CVS:
removing added dirs
2005-12-16 18:29:42 +00:00
Stefan Kost b32ebdaabe added documentation to many items moved the GST_TYPE_XXX one to the Standart section, as they do not need docs
Original commit message from CVS:
added documentation to many items
moved the GST_TYPE_XXX one to the Standart section, as they do not need docs
2004-09-02 14:24:22 +00:00
Stefan Kost 978c272fa3 moved docs to sgml files added first batch of docs provided by ronald
Original commit message from CVS:
moved docs to sgml files
added first batch of docs provided by ronald
2004-08-31 17:14:03 +00:00
Thomas Vander Stichele 9d89e287ff add flag, reorder GstBuffer docs
Original commit message from CVS:
add flag, reorder GstBuffer docs
2004-08-12 10:56:40 +00:00
Stefan Kost 1312d71475 adding a title to some examples so that they appear in the example index disabled the global index, as this does not ...
Original commit message from CVS:
adding a title to some examples so that they appear in the example index
disabled the global index, as this does not yet fully work
2004-07-14 15:06:31 +00:00
Thomas Vander Stichele 864b8837cf describe IN_CAPS
Original commit message from CVS:
describe IN_CAPS
2004-06-05 12:05:43 +00:00
Thomas Vander Stichele f5c0bfd459 releasing
Original commit message from CVS:
releasing
2004-06-04 11:17:01 +00:00
Thomas Vander Stichele c1125590b2 more doc build fixes
Original commit message from CVS:
more doc build fixes
2004-04-08 14:45:13 +00:00
David Schleef 209c82ee06 docs/gst/gstreamer-sections.txt: More doc hacking.
Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:  More doc hacking.
* docs/gst/tmpl/gstaggregator.sgml:
* docs/gst/tmpl/gstautoplugfactory.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstbufferstore.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstmd5sink.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstsearchfuncs.sgml:
* docs/gst/tmpl/gstshaper.sgml:
* docs/gst/tmpl/gstspider.sgml:
* docs/gst/tmpl/gsttee.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstvalue.sgml:
* docs/gst/tmpl/gstxml.sgml:
* gst/Makefile.am:  Remove gstthreaddummy.c.  It never worked,
and we don't support it.
* gst/gst.c: (gst_init_get_popt_table), (init_pre), (init_post),
(gst_use_threads), (gst_has_threads): same
* gst/gstthreaddummy.c: same
* gst/autoplug/gstspider.c: Make gst_spider_details static.
* gst/autoplug/gstspider.h: same
* gst/elements/gstaggregator.h: Remove bogus function from header
* gst/elements/gstfakesink.h: same
* gst/elements/gstfakesrc.h: same
* gst/elements/gstmd5sink.h: same
* gst/elements/gstshaper.h: same
* gst/elements/gsttee.h: same
* gst/gstbin.c: doc fixes
* gst/gstbin.h: Remove unused definition.
* gst/gstbuffer.c: doc fixes
* gst/gstcaps.c: (gst_caps_is_always_compatible): doc fixes
* gst/gstfilter.c: doc fixes
* gst/gsttag.c: doc fixes
* gst/gstvalue.c: doc fixes
2004-03-26 03:46:16 +00:00
David Schleef 1e4ad29e52 docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo...
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:  I got tired of the reference
manual being such complete crap, that I decided to do major
hacking of it.  This checkin replaces any fine tuning that
may have been done previously, with the benefit of actually
being complete for much of the API that was changed since
0.6.  Further fine tuning will occur shortly.  (bug #134721)
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/GstBin.sgml:
* docs/gst/tmpl/GstBuffer.sgml:
* docs/gst/tmpl/GstCaps.sgml:
* docs/gst/tmpl/GstClock.sgml:
* docs/gst/tmpl/GstCompat.sgml:
* docs/gst/tmpl/GstData.sgml:
* docs/gst/tmpl/GstElement.sgml:
* docs/gst/tmpl/GstEvent.sgml:
* docs/gst/tmpl/GstIndex.sgml:
* docs/gst/tmpl/GstStructure.sgml:
* docs/gst/tmpl/GstTag.sgml:
* docs/gst/tmpl/cothreads.sgml:
* docs/gst/tmpl/cothreads_compat.sgml:
* docs/gst/tmpl/gettext.sgml:
* docs/gst/tmpl/grammar.tab.sgml:
* docs/gst/tmpl/gst-i18n-app.sgml:
* docs/gst/tmpl/gst-i18n-lib.sgml:
* docs/gst/tmpl/gst.sgml:
* docs/gst/tmpl/gst_private.sgml:
* docs/gst/tmpl/gstaggregator.sgml:
* docs/gst/tmpl/gstarch.sgml:
* docs/gst/tmpl/gstatomic.sgml:
* docs/gst/tmpl/gstatomic_impl.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstbufferstore.sgml:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstconfig.sgml:
* docs/gst/tmpl/gstcpu.sgml:
* docs/gst/tmpl/gstdata.sgml:
* docs/gst/tmpl/gstdata_private.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstenumtypes.sgml:
* docs/gst/tmpl/gsterror.sgml:
* docs/gst/tmpl/gstevent.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstfilesink.sgml:
* docs/gst/tmpl/gstfilter.sgml:
* docs/gst/tmpl/gstindex.sgml:
* docs/gst/tmpl/gstinfo.sgml:
* docs/gst/tmpl/gstinterface.sgml:
* docs/gst/tmpl/gstlog.sgml:
* docs/gst/tmpl/gstmacros.sgml:
* docs/gst/tmpl/gstmarshal.sgml:
* docs/gst/tmpl/gstmd5sink.sgml:
* docs/gst/tmpl/gstmultifilesrc.sgml:
* docs/gst/tmpl/gstobject.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstparse.sgml:
* docs/gst/tmpl/gstpipeline.sgml:
* docs/gst/tmpl/gstplugin.sgml:
* docs/gst/tmpl/gstpluginfeature.sgml:
* docs/gst/tmpl/gstqueue.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstregistry.sgml:
* docs/gst/tmpl/gstregistrypool.sgml:
* docs/gst/tmpl/gstscheduler.sgml:
* docs/gst/tmpl/gstsearchfuncs.sgml:
* docs/gst/tmpl/gstshaper.sgml:
* docs/gst/tmpl/gstspider.sgml:
* docs/gst/tmpl/gstspideridentity.sgml:
* docs/gst/tmpl/gststructure.sgml:
* docs/gst/tmpl/gstsystemclock.sgml:
* docs/gst/tmpl/gsttag.sgml:
* docs/gst/tmpl/gsttaginterface.sgml:
* docs/gst/tmpl/gsttee.sgml:
* docs/gst/tmpl/gstthread.sgml:
* docs/gst/tmpl/gsttrace.sgml:
* docs/gst/tmpl/gsttrashstack.sgml:
* docs/gst/tmpl/gsttypefind.sgml:
* docs/gst/tmpl/gsttypes.sgml:
* docs/gst/tmpl/gsturi.sgml:
* docs/gst/tmpl/gsturitype.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstvalue.sgml:
* docs/gst/tmpl/gstversion.sgml:
* docs/gst/tmpl/gstxml.sgml:
* docs/gst/tmpl/gstxmlregistry.sgml:
* docs/gst/tmpl/gthread-cothreads.sgml:
* docs/gst/tmpl/types.sgml:
2004-03-25 04:20:33 +00:00
Thomas Vander Stichele fdfb2b8232 configure.ac: remove whitespace
Original commit message from CVS:
* configure.ac:
remove whitespace
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstdata.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstxml.sgml:
doc update
* docs/manuals.mak:
add a FIXME
* docs/pwg/intro-preface.xml:
* docs/pwg/pwg.xml:
remove GNOME
* gst/gst.c: (init_post):
try GST_PLUGIN_PATH paths for the _global_registry first
* gst/gstelement.h:
add the error message as well, otherwise (null) debug info doesn't
make much sense
* tools/gst-register.c: (main):
spill paths to next registry if this registry is not writable
* po/fr.po:
* po/nl.po:
translation updates
2004-03-01 17:15:28 +00:00
Thomas Vander Stichele 13ef4f4290 sync latest api changes
Original commit message from CVS:
sync latest api changes
2004-01-20 18:48:32 +00:00
Thomas Vander Stichele 339012e033 fix up docs remove props commit automatic moving and removing of documentation
Original commit message from CVS:
fix up docs
remove props
commit automatic moving and removing of documentation
2004-01-07 16:32:24 +00:00
Benjamin Otte 46a70fddfb removed GST_*_CAST. Disabling of type checking is done in glib.
Original commit message from CVS:
removed GST_*_CAST. Disabling of type checking is done in glib.
2003-12-13 16:58:29 +00:00
Benjamin Otte 385b9ee5c4 merge in tagging
Original commit message from CVS:
merge in tagging
Includes:
- gsttag.[ch] - The definition of GstTagList and tag registering/querying
- gsttaginterface.[ch] - Interface for elements that can handle setting of tags
- updates and merges to gststructure.[ch] and gstvalue.[ch]
- testsuite/tags - some tests for tagging
- bugfixes
- updates to make make distcheck work
- updates the version number to 0.7.2.1

Does not include:
- including tagging stuff in docs
- extensive tests
2003-11-24 02:09:23 +00:00
Benjamin Otte 1211e26e59 docs fixes: comment macros in templates, not in headers (stupid gtk-doc)
Original commit message from CVS:
docs fixes: comment macros in templates, not in headers (stupid gtk-doc)
2003-06-29 14:57:19 +00:00
Wim Taymans a6dfa0f792 Documentation updates
Original commit message from CVS:
Documentation updates
2003-02-10 23:01:55 +00:00
Wim Taymans fa4df1659f Small updates
Original commit message from CVS:
Small updates
2002-12-19 20:38:51 +00:00
Wim Taymans f84bb46f06 Fix unused args
Original commit message from CVS:
Fix unused args
2002-12-14 16:32:28 +00:00
Wim Taymans 29e2850eff Documentation updates
Original commit message from CVS:
Documentation updates
2002-12-14 13:02:16 +00:00
Andy Wingo 52ec4f4e5b add core elements to the registry pool plugin list fix python check
Original commit message from CVS:
* add core elements to the registry pool plugin list
* fix python check
2002-08-31 18:17:02 +00:00
Thomas Vander Stichele 56c8649f39 doc updates
Original commit message from CVS:
doc updates
2002-08-30 14:54:58 +00:00
Wim Taymans b5c170f42a API docs updates
Original commit message from CVS:
API docs updates
2002-07-12 23:21:20 +00:00
Andy Wingo 30879f4362 doc fixen
Original commit message from CVS:
doc fixen
2002-07-11 19:40:06 +00:00
Wim Taymans 9df69622d9 Documentation updates
Original commit message from CVS:
Documentation updates
2002-06-12 22:27:18 +00:00
Thomas Vander Stichele af8f04c56e more change
Original commit message from CVS:
more change
2002-04-17 14:58:17 +00:00
Thomas Vander Stichele d2af387684 review of gstbuffer documentation small doc fixes
Original commit message from CVS:
* review of gstbuffer documentation
* small doc fixes
2002-04-17 12:28:32 +00:00
Andy Wingo 43cbc42c45 the 'brown paper bag' commit. sorry for the email spam on this one, but it will be laaaarrrggggeee
Original commit message from CVS:
the 'brown paper bag' commit. sorry for the email spam on this one, but it will be laaaarrrggggeee
2002-01-15 00:41:22 +00:00
Andy Wingo f38969ff25 fix doc build for glib2 remove template files from cvs, they are generated with gtkdoc-mktmpl new, cleaner interface ...
Original commit message from CVS:
* fix doc build for glib2
* remove template files from cvs, they are generated with gtkdoc-mktmpl
* new, cleaner interface to the parser facilities
* cleanups in gstparse.c
2002-01-14 04:09:56 +00:00
Wim Taymans ff0ca25b48 API docs updates.
Original commit message from CVS:
API docs updates.
2002-01-01 15:59:05 +00:00
Wim Taymans 27d784dc03 documentation updates
Original commit message from CVS:
documentation updates
2001-12-28 20:27:59 +00:00
Wim Taymans dd71e3fbd9 Added the shims for int64. some small updates.
Original commit message from CVS:
Added the shims for int64.
some small updates.
according to gtkdoc we now have:
1e+02% function docs coverage (444 functions documented, 0 not documented)
:)
2001-10-24 18:41:49 +00:00
Wim Taymans 710d1ae0d2 More updates to the API docs.
Original commit message from CVS:
More updates to the API docs.
2001-10-21 15:47:23 +00:00
Wim Taymans e5b6d0c8aa More pending API doc changes.
Original commit message from CVS:
More pending API doc changes.
2001-10-21 01:02:25 +00:00
Wim Taymans 9ba56f4181 Get the API docs back in shape. This batch of patches contain the updates that don't require source code comment chan...
Original commit message from CVS:
Get the API docs back in shape. This batch of patches contain the updates
that don't require source code comment changes.
2001-10-19 22:49:35 +00:00
Erik Walthinsen d574ab8126 merge from EVENTS1 on 20011016
Original commit message from CVS:
merge from EVENTS1 on 20011016
2001-10-17 10:21:27 +00:00
Wim Taymans 5d2a56cd7c Removed the last bits of Metadata.
Original commit message from CVS:
Removed the last bits of Metadata.
Updated the bufferpool docs.
2001-07-07 10:55:58 +00:00
Wim Taymans 17f02e233d API docs updates
Original commit message from CVS:
API docs updates
2001-05-03 20:06:18 +00:00
Wim Taymans 892f4b3204 API docs updates.
Original commit message from CVS:
API docs updates.
Properly implemented the disksink.
Fixed a compile problem with alsa.
Added bufferpool handling to dvdec
Some compiler warning fixes
2001-04-22 16:04:19 +00:00
Wim Taymans 9ee943b389 Added more API docs to Autoplug, Buffer, Bin, BufferPool.
Original commit message from CVS:
Added more API docs to Autoplug, Buffer, Bin, BufferPool.
Fixed some compile problems with videosink
2001-04-18 20:16:53 +00:00
Wim Taymans 6bd5dcffab The first wave of docs updates
Original commit message from CVS:
The first wave of docs updates
Added a little more comments about the API usage in the api docs.
Some fixes for the capsnego testsuite.
2001-04-17 21:14:55 +00:00
Wim Taymans 1340064d57 More doc updates
Original commit message from CVS:
More doc updates
Manual additions: xml/load save of custom XML, debugging, request pads
added a signal to the example plugin
fixed a bug in mp3parse (ifdef 1)
2001-02-22 23:18:51 +00:00
Erik Walthinsen 7c51d6e0ca Cleaned up the docs a bit.
Original commit message from CVS:
Cleaned up the docs a bit.
2001-01-06 22:05:15 +00:00
Wim Taymans 3b805b9209 Docs updates: remove sink, src, filter, connection added gstinfo to docs.
Original commit message from CVS:
Docs updates: remove sink, src, filter, connection
added gstinfo to docs.
Updated some core files for the docs
gsttypefind did not include gst_private
Added CFlags to Makefile.am in gst/elements
2000-12-30 16:13:17 +00:00
Wim Taymans 9655c3b593 Updated the API docs.
Original commit message from CVS:
Updated the API docs.
2000-12-28 21:42:23 +00:00
Wim Taymans 268bcbb89d More docs updates
Original commit message from CVS:
More docs updates
2000-10-22 16:30:25 +00:00
Wim Taymans 56e7d38238 Bring the low level API docs up to date.
Original commit message from CVS:
Bring the low level API docs up to date.
2000-09-13 19:04:55 +00:00
Wim Taymans bf8c785fb0 Documentation updates. All standard library objects and standard elements are documented. Modified some of the elemen...
Original commit message from CVS:
Documentation updates. All standard library objects and standard
elements are documented. Modified some of the elements to more
accuratly report about their arguments so the documentation builds
more reasonable output.
Added aviencoder and jpegencoder elements (not working yet)
2000-03-27 19:53:43 +00:00
Erik Walthinsen 56a79fbfcc Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system.  I'd managed to mutilate it a while back,
but now it's fixed.  I'll put a copy of the HTML output somewhere on the
website tonight.

In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs.  (see
http://developer.gnome.org/arch/doc/tools.html)

Notes (I'll codify these some day):

- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file.  However, gtk-doc's merge and CVS's diff are
two entirely separate animals.  We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book.  There'd be another called docs/manual/, and
another docs/plugins/, etc.  If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00