Commit graph

102 commits

Author SHA1 Message Date
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
186221d6e0 doc fixes
Original commit message from CVS:
doc fixes
2004-06-24 23:05:04 +00:00
Thomas Vander Stichele
395c4b195b fix distcheck
Original commit message from CVS:
fix distcheck
2004-05-20 12:40:31 +00:00
Stefan Kost
9fa85fa424 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
2004-05-14 15:17:30 +00:00
Stefan Kost
8178973c41 enabled gobject hierarchy in the gtk-doc enabled the GstQueue class in the gtk-doc added a few missing symbols so tha...
Original commit message from CVS:
enabled gobject hierarchy in the gtk-doc
enabled the GstQueue class in the gtk-doc
added a few missing symbols so that the hierachy works
2004-05-14 14:00:04 +00:00
David Schleef
8ce063f780 docs/gst/Makefile.am: Disable a bunch of headers from being scanned
Original commit message from CVS:
* docs/gst/Makefile.am:  Disable a bunch of headers from being scanned
* docs/gst/gstreamer-docs.sgml:  More hacking
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/cothreads_compat.sgml:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstevent.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstxml.sgml:
* docs/gst/tmpl/gthread-cothreads.sgml:
* docs/random/ds/0.9-suggested-changes:
* gst/elements/gstfakesink.h: doc fixes
* gst/elements/gstfakesrc.h: doc fixes
* gst/gstcaps.c: doc fixes
* gst/gstcaps.h: doc fixes
* gst/gstelement.c: doc fixes
* gst/gstelement.h: doc fixes
* gst/gstindex.c: doc fixes
* gst/gstinfo.c: doc fixes
* gst/gstpad.c: doc fixes
* gst/gstpad.h: doc fixes
* gst/gstplugin.c: doc fixes
* gst/gsttypefind.h: doc fixes
* gst/gsturi.c: doc fixes
* gst/gstvalue.c: doc fixes
2004-03-30 07:36:19 +00:00
David Schleef
e2e72a8993 docs/gst/gstreamer-docs.sgml: More fine tuning.
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml: More fine tuning.
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstautoplug.sgml:
* docs/gst/tmpl/gststaticautoplug.sgml:
* docs/gst/tmpl/gststaticautoplugrender.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstxml.sgml:
2004-03-25 19:26:26 +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
78066caf1a version API docs
Original commit message from CVS:
version API docs
2004-02-12 17:23:37 +00:00
Thomas Vander Stichele
cdda2aa934 make sure all API gets built sync .c with .h
Original commit message from CVS:
make sure all API gets built
sync .c with .h
2004-01-30 19:06:13 +00:00
Thomas Vander Stichele
0d7d7838a3 rearrange documentation
Original commit message from CVS:
rearrange documentation
2004-01-28 14:33:59 +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
Thomas Vander Stichele
f57a372393 more trademark protectoin and doc fixing
Original commit message from CVS:
more trademark protectoin and doc fixing
2003-12-05 12:26:58 +00:00
David Schleef
57fcf33e5e Remove old autoplug code
Original commit message from CVS:
Remove old autoplug code
2003-11-29 05:29:30 +00:00
Benjamin Otte
3235f1d4c0 merge TYPEFIND branch. Major changes:
Original commit message from CVS:
merge TYPEFIND branch. Major changes:
- totally reworked type(find) system
- bytestream is out of the core again
- typefind element is now part of gstelements
2003-10-28 20:25:30 +00:00
Benjamin Otte
803ce6bf48 GST_DEBUG reorganization containing loads of stuff:
Original commit message from CVS:
GST_DEBUG reorganization
This is a big diff (ca 450k), containing loads of stuff:
- gstinfo.[ch] complete rewrite
- changing of all GST_DEBUG messages to reflect that change
- reorganization of subsystem disabling
- addition of gstconfig.h.in so we can track the disablings
- <gst/gst.h> does not include <unistd.h> and <config.h> anymore
- documentation updated for gstinfo stuff (build the docs yourself to know what changed)
- bugfixes for making of the docs (files from CVS are not deleted anymore
- testsuite for debugging changes in testsuite/debug

expect breakage
2003-06-29 14:05:49 +00:00
Thomas Vander Stichele
50251fcfec converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno...
Original commit message from CVS:
converting to xml as intermediary step to fix devhelp generation
assorted doc build fixes as well
http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
Wim Taymans
a6dfa0f792 Documentation updates
Original commit message from CVS:
Documentation updates
2003-02-10 23:01:55 +00:00
Wim Taymans
7462cb8787 Documentation updates
Original commit message from CVS:
Documentation updates
2003-01-02 18:56:09 +00:00
Wim Taymans
6d097f337e Documentation updates
Original commit message from CVS:
Documentation updates
2002-12-30 17:54:02 +00:00
Wim Taymans
1ac723870e Documentation updates
Original commit message from CVS:
Documentation updates
2002-12-14 16:22:01 +00:00
Wim Taymans
29e2850eff Documentation updates
Original commit message from CVS:
Documentation updates
2002-12-14 13:02:16 +00:00
Wim Taymans
b5c170f42a API docs updates
Original commit message from CVS:
API docs updates
2002-07-12 23:21:20 +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
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
Thomas Vander Stichele
14d7369b5b rename the books so the discerning elements move up front
Original commit message from CVS:
rename the books so the discerning elements move up front
2002-04-16 16:27:26 +00:00
Wim Taymans
d30487f9d0 Documentation updates
Original commit message from CVS:
Documentation updates
2002-03-31 14:00:33 +00:00
Andy Wingo
57dc4b544d doc and configure updates, and the beginnings of gst-xmllaunch
Original commit message from CVS:
doc and configure updates, and the beginnings of gst-xmllaunch
2002-01-14 07:18:43 +00:00
Andy Wingo
35aa5cebdf global s/disksrc/filesrc/, but edited by me
Original commit message from CVS:
global s/disksrc/filesrc/, but edited by me
2002-01-06 04:26:37 +00:00
Andy Wingo
e4bba88ae9 minor typographical change to autogen added --with-html-dir option to configure more robust docbook checks convert to...
Original commit message from CVS:
* minor typographical change to autogen
* added --with-html-dir option to configure
* more robust docbook checks
* convert to standard docbook makefiles, at least for the gst/ directory
* added filesrc.h so that docbook can know about filesrc
* updated -sections.txt because docbook is incredibly stupid and requires that at
least one of the lines between <section> and </section> is not an entity
* first pass at possible getting the docs to build on glib2, untested
2001-12-12 06:08:44 +00:00
Wim Taymans
3e5a0a6d72 Updated the API docs
Original commit message from CVS:
Updated the API docs
2001-12-09 13:17:13 +00:00
Wim Taymans
0bb01afa84 Split out the padtemplate, autoplugfactoy and elementfactory into different pages to be able to show more examples an...
Original commit message from CVS:
Split out the padtemplate, autoplugfactoy and elementfactory into different
pages to be able to show more examples and the object hierarchy.
2001-10-24 21:44:48 +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
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
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
1523fcb150 API docs updates.
Original commit message from CVS:
API docs updates.
2001-05-27 14:33:30 +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
406541cec0 Fixed the doc build warnings
Original commit message from CVS:
Fixed the doc build warnings
2001-04-10 19:46:23 +00:00
Wim Taymans
10e29412ff Removed the audiosink/src from the docs.
Original commit message from CVS:
Removed the audiosink/src from the docs.
Removed the audioraw metadata file from the docs.
2001-03-27 16:25:00 +00:00
Wim Taymans
1d040471a4 API docs updates
Original commit message from CVS:
API docs updates
2001-03-21 21:43:56 +00:00
David I. Lehn
fcc2acfa37 Removed asyncdisksrc references from docs.
Original commit message from CVS:
Removed asyncdisksrc references from docs.
2001-02-21 20:45:00 +00:00
Wim Taymans
804c1b2653 Documentation updates.
Original commit message from CVS:
Documentation updates.
2001-01-31 20:27:00 +00:00
Wim Taymans
75aa948e0c Docs updates
Original commit message from CVS:
Docs updates
Added XML load from memory functionality
Undid the videosink patch, something else is wrong now on my machine:
no MMX acceleration :-(
2001-01-21 23:20:46 +00:00
Wim Taymans
9b3f1277ce API docs updates
Original commit message from CVS:
API docs updates
2001-01-19 22:15:21 +00:00
Wim Taymans
adf0ffecb4 Remove esdsink from the docs more fixes for symbols collisions
Original commit message from CVS:
Remove esdsink from the docs
more fixes for symbols collisions
2001-01-02 18:40:43 +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
e990c2c7d5 Updated docs
Original commit message from CVS:
Updated docs
2000-11-07 21:18:52 +00:00
Wim Taymans
894215eb29 Documentation updates documented the libraries
Original commit message from CVS:
Documentation updates
documented the libraries
2000-10-22 16:27:21 +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