Commit graph

33 commits

Author SHA1 Message Date
Tim-Philipp Müller
6eb6d9ec38 docs: remove outdated and pointless 'Last reviewed' lines from docs
They are very confusing for people, and more often than not
also just not very accurate. Seeing 'last reviewed: 2005' in
your docs is not very confidence-inspiring. Let's just remove
those comments.
2014-04-26 21:21:51 +01:00
Christian Fredrik Kalager Schaller
9301305cd6 Remove two last .fig files from build, they are now replaced with .svg files. That said I don't think either .fig file was still being used anywhere. With this
change and the one in common GStreamer no longer depends on xfig.
2012-11-19 13:38:30 +01:00
Piotr Fusik
14f5518f3d docs, gst: typo fixes
https://bugzilla.gnome.org/show_bug.cgi?id=658449
2011-09-07 18:03:17 +01:00
Thijs Vermeir
b51df5f3a8 Fix typo 2009-01-24 14:37:14 +01:00
Stefan Kost
bc82d5536c docs/README: Document that for plgin-docs we extraxt he short-desc from the element details.
Original commit message from CVS:
* docs/README:
Document that for plgin-docs we extraxt he short-desc from the element
details.
* docs/design/part-states.txt:
Tell that devices should be closed in PAUSED -> READY.
* docs/manual/README:
Document how tests in the manual are handled.
* docs/manuals.mak:
Typo in comment.
2008-06-25 14:25:49 +00:00
Jan Schmidt
450fa6366a docs/Makefile.am: Don't descend into the plugins dir if plugin docs building is disabled.
Original commit message from CVS:
* docs/Makefile.am:
Don't descend into the plugins dir if plugin docs building
is disabled.
* docs/README:
Add a note about the new type:GTypeName syntax for the plugin
documentation .types file.
2008-05-17 17:20:51 +00:00
Stefan Kost
467156e77b docs/README: Correct file path. Tell about how to use -overrides.txt.
Original commit message from CVS:
* docs/README:
Correct file path. Tell about how to use -overrides.txt.
* docs/design/draft-tagreading.txt:
Small design update.
2008-04-15 05:54:13 +00:00
Tim-Philipp Müller
39bfee4a94 docs/README: Add a few lines about the new 'check-inspected-versions' target.
Original commit message from CVS:
* docs/README:
Add a few lines about the new 'check-inspected-versions' target.
2008-02-23 16:03:37 +00:00
Stefan Kost
036d5105f5 docs/README: Some more details about how the plugin docs works.
Original commit message from CVS:
* docs/README:
Some more details about how the plugin docs works.
* docs/plugins/gstreamer-plugins-sections.txt:
Whitespace cleanup.
2008-02-01 12:25:17 +00:00
Thomas Vander Stichele
0cf3c8bc14 update README
Original commit message from CVS:
update README
2007-04-29 14:04:26 +00:00
Thomas Vander Stichele
0734eb921c docs/: add a gdp image
Original commit message from CVS:

* docs/README:
* docs/images/gdp-header.svg:
add a gdp image
* docs/libs/Makefile.am:
* docs/libs/gdp-header.png:
* libs/gst/dataprotocol/dataprotocol.c:
add it to the API docs
* docs/manual/intro-motivation.xml:
fix typo
2006-06-13 19:24:34 +00:00
Stefan Kost
cfbd7ba925 docs/README: formatting fix
Original commit message from CVS:
* docs/README:
formatting fix
* plugins/elements/gstidentity.c:
* plugins/elements/gstqueue.c:
* plugins/elements/gsttee.c:
* plugins/elements/gsttypefindelement.c:
GST_ELEMENT_DETAILS formatting
2006-03-24 10:38:20 +00:00
Tim-Philipp Müller
be8316429d docs/README: Tell folks what to do if the plugin-foobar.xml file hasn't been generated for a newly-added plugin.
Original commit message from CVS:
* docs/README:
Tell folks what to do if the plugin-foobar.xml file
hasn't been generated for a newly-added plugin.
2006-02-06 10:42:01 +00:00
Stefan Kost
523041b533 docs/: describe dparams (controller) for plugins unify docs a little more
Original commit message from CVS:
* docs/README:
* docs/manual/intro-basics.xml:
* docs/manual/intro-preface.xml:
* docs/manual/manual.xml:
* docs/pwg/advanced-dparams.xml:
* docs/pwg/intro-basics.xml:
* docs/pwg/intro-preface.xml:
* docs/pwg/pwg.xml:
describe dparams (controller) for plugins
unify docs a little more
2006-02-02 11:24:19 +00:00
Thomas Vander Stichele
e8e9419823 updates for plugin docs
Original commit message from CVS:
updates for plugin docs
2006-02-01 08:27:24 +00:00
Thomas Vander Stichele
01a038bd56 remove empty dirs; move docbuilding notes
Original commit message from CVS:
remove empty dirs; move docbuilding notes
2005-11-30 16:42:27 +00:00
Thomas Vander Stichele
d581d5c976 doc updates
Original commit message from CVS:

* docs/README:
* docs/gst/gstreamer-sections.txt:
* gst/gstbin.c:
doc updates
* gst/gstregistry.c: (gst_registry_scan_path_level):
fix for a nasty little missed situation where an installed plug-in
which was in the cache did not get overridden by an uninstalled one
which was earlier in the plugin path because the newly created plugin
for the uninstalled one (not in the registry) didn't get its
->registered set to TRUE
2005-11-02 15:34:23 +00:00
Thomas Vander Stichele
201e8082ad some style fixes
Original commit message from CVS:
some style fixes
2005-10-28 16:54:15 +00:00
Thomas Vander Stichele
846f229d67 add style guide
Original commit message from CVS:
add style guide
2005-10-28 16:08:52 +00:00
Thomas Vander Stichele
3f519e30e9 various doc updates
Original commit message from CVS:

* docs/README:
* gst/gstpad.c: (gst_pad_class_init), (gst_pad_chain):
* gst/gstpluginfeature.c:
* gst/gstutils.c:
various doc updates
* gst/base/gstbasesink.c: (gst_base_sink_handle_object):
change an assert into an error until it gets fixed properly
2005-09-23 15:36:28 +00:00
Thomas Vander Stichele
1b8f44e409 check/: enable cleanup again after fixing the leak
Original commit message from CVS:
* check/Makefile.am:
* check/pipelines/cleanup.c: (run_pipeline):
* check/pipelines/simple_launch_lines.c: (run_pipeline),
(GST_START_TEST):
enable cleanup again after fixing the leak
* docs/README:
some more info on docs
2005-09-19 14:41:57 +00:00
Thomas Vander Stichele
58a4a1a7bf notes on documenting elements and plugins
Original commit message from CVS:
notes on documenting elements and plugins
2005-09-14 22:01:45 +00:00
Thomas Vander Stichele
e7164d4b1e maintenance updates
Original commit message from CVS:
maintenance updates
2005-09-05 11:54:55 +00:00
Stefan Kost
35441095b2 another shell oneliner for empty return value docs more doc fixes (parameters and return values)
Original commit message from CVS:
another shell oneliner for empty return value docs
more doc fixes (parameters and return values)
2005-01-05 13:17:28 +00:00
Stefan Kost
e2de071d42 quick shell oneliner to find undocumented members in docs/README more enumtypes cleanup activated documentation comme...
Original commit message from CVS:
quick shell oneliner to find undocumented members in docs/README
more enumtypes cleanup
activated documentation comments, now someone needs to document the enums :(
2005-01-04 18:13:51 +00:00
Stefan Kost
626cbdc8b2 cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to R...
Original commit message from CVS:
cleanup of unused and forgoten sections
fixed links from the manual and the pwg to the API docs
added more notes to README
2004-07-27 15:01:10 +00:00
Stefan Kost
e4c86da4f5 fixed all double <TITLE> elements in sections.txt added missing <TITLE> elements in sections.txt
Original commit message from CVS:
fixed all double <TITLE> elements in sections.txt
added missing <TITLE> elements in sections.txt
2004-07-26 16:34:35 +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
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
Thomas Vander Stichele
b68e4b9d00 fixing docs errors
Original commit message from CVS:
fixing docs errors
2004-02-03 10:47:26 +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
d839d3c63c collect docs notes
Original commit message from CVS:
collect docs notes
2004-01-28 15:37:33 +00:00
Thomas Vander Stichele
d494eef5a7 readme
Original commit message from CVS:
readme
2003-09-11 10:47:32 +00:00