Commit graph

42 commits

Author SHA1 Message Date
Stefan Kost
e719825726 more api documentation better error signaling and logging
Original commit message from CVS:
more api documentation
better error signaling and logging
2004-10-13 13:03:25 +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
f40bd6fe7e put xmlNodePtr macro into the right section
Original commit message from CVS:
put xmlNodePtr macro into the right section
2004-07-21 12:48:45 +00:00
Stefan Kost
21e56edfbc put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols) added TITLE ...
Original commit message from CVS:
put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols)
added TITLE tags where they were missing
fixed section names so that gtk-doc introspection works
fixed typos in api docs and docbook docs
added some thoughts about new interfaces (to personal notes)
2004-07-21 11:32:09 +00:00
Thomas Vander Stichele
f55a8091a6 remove gst_info remove gstlog.h, fold back to gstinfo.h update translations
Original commit message from CVS:
remove gst_info
remove gstlog.h, fold back to gstinfo.h
update translations
2004-05-03 16:03:24 +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
Johan Dahlin
ecd88e381d Revert again, this time without post-commit reindent hooks to put back the indentation :-)
Original commit message from CVS:
Revert again, this time without post-commit reindent hooks
to put back the indentation :-)
2004-03-15 14:43:35 +00:00
Thomas Vander Stichele
a967370df5 gst-indent run on core
Original commit message from CVS:
gst-indent run on core
2004-03-13 15:27:01 +00:00
Thomas Vander Stichele
de988971b5 fix testsuite from segfaulting
Original commit message from CVS:
fix testsuite from segfaulting
2004-02-06 16:25:31 +00:00
Thomas Vander Stichele
16cfcc2d33 appease libtool gods bump to prerel version
Original commit message from CVS:
appease libtool gods
bump to prerel version
2004-02-04 21:29:38 +00:00
Thomas Vander Stichele
b68e4b9d00 fixing docs errors
Original commit message from CVS:
fixing docs errors
2004-02-03 10:47:26 +00:00
Benjamin Otte
192330d37a parts of the patch submitted in bug #113913
Original commit message from CVS:
2004-01-30  Laurent Vivier <Laurent.Vivier@bull.net>

reviewed by Benjamin Otte
parts of the patch submitted in bug #113913

* configure.ac:
use AC_C_INLINE. Use = instead of == with test
* examples/plugins/example.c:
* gst/autoplug/gstspideridentity.c:
* gst/elements/gstfdsrc.c:
* gst/elements/gstfilesrc.c:
* gst/elements/gstidentity.c:
* gst/elements/gstmultidisksrc.c:
* gst/elements/gststatistics.c:
* gst/gstelement.c:
* gst/gstobject.c:
* gst/gstpad.c:
* gst/gstpipeline.c:
* gst/gstthread.c:
don't end enums with a comma
* gst/gstindex.c: (gst_index_compare_func):
do explicit casting to gint
* gst/gsttrace.c: (gst_trace_text_flush):
#define strsize as a macro
2004-01-30 20:48:13 +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
Andy Wingo
8ca1b1fe7f remove copyright field from plugin structs
Original commit message from CVS:
remove copyright field from plugin structs
2003-12-04 10:02:41 +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
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
Thomas Vander Stichele
7eea6a04b7 fix for parallel installability
Original commit message from CVS:
fix for parallel installability
2002-12-08 14:39:38 +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
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
Wim Taymans
d30487f9d0 Documentation updates
Original commit message from CVS:
Documentation updates
2002-03-31 14:00:33 +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
deef4ecb49 Added some more object to the object hierarchy
Original commit message from CVS:
Added some more object to the object hierarchy
2001-10-24 19:55:12 +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
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
1523fcb150 API docs updates.
Original commit message from CVS:
API docs updates.
2001-05-27 14:33:30 +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
Wim Taymans
804c1b2653 Documentation updates.
Original commit message from CVS:
Documentation updates.
2001-01-31 20:27:00 +00:00
Wim Taymans
a0c0706dfb Made sure -g is not used when no --enable-debug
Original commit message from CVS:
Made sure -g is not used when no --enable-debug
Updated AUTHORS in gstmediaplay
2001-01-07 17:09:28 +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
3d34ce7b95 Updated the manual and the docs.
Original commit message from CVS:
Updated the manual and the docs.
Removed the esdsink in gst/elements/ we have a real one not in the
plugins dir.
Added more APIs to query the plugins, types and caps. more fields now
have a getter and a setter. This is needed to make gstreamer wrapper
fiendly.
Added gst_element_disconnect beacuse we also have a gst_element_connect
2001-01-06 02:35:17 +00:00
Erik Walthinsen
df81ae1765 updated API docs
Original commit message from CVS:
updated API docs
2001-01-04 22:16:06 +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
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