Commit graph

2738 commits

Author SHA1 Message Date
Jan Alexander Steffens (heftig)
a2742a575b pwg: Update raw properties
Using info from gst-plugins-base/docs/design .

Encoded streams might make use of the raw properties, so list them all under foo/* .
For foo/raw, only note which of these properties are mandatory.

I didn't take a closer look at the raw formats yet. Those might still be out-of-date.

https://bugzilla.gnome.org/show_bug.cgi?id=724187
2014-02-17 18:47:20 +01:00
Stefan Sauer
f5fae6f339 docs: add the boxed types to the .types.in
This makes them show up in the object hierarchy.
2014-02-15 22:35:37 +01:00
Stefan Sauer
b892b438cc docs: gtkdoc is not good at parsing inline functions in headers
Mark the inline function, so that gtkdoc skips them. Avoids some warnings about
unparsable declarations.
2014-02-15 21:27:23 +01:00
Sebastian Dröge
f47c704b99 basesrc: Add gst_base_src_set_automatic_eos() API
This defaults to TRUE and if it is set to FALSE it is the subclasses
responsibility to return GST_FLOW_EOS from the create() vmethod once
the stream is done.
2014-02-13 12:09:06 +01:00
William Manley
be8eeabefc docs: Fix location of plugins and registry in home directories
Fixes out of date documentation left over since 0.10.  In 1.0 plugins are
stored in $XDG_DATA_HOME and the registry in $XDG_CACHE_HOME conformant
with the XDG Base Directory Specification[1].

[1]: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

https://bugzilla.gnome.org/show_bug.cgi?id=724132
2014-02-11 20:56:48 +01:00
Sebastian Rasmussen
f0047132a1 docs: add missing seqnum file for distribution
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=723997
2014-02-10 09:35:34 +01:00
Tim-Philipp Müller
b23af1f2f2 docs: document GST_TAG_*ENCODING environment variables
https://bugzilla.gnome.org/show_bug.cgi?id=721850
2014-02-09 16:53:55 +00:00
Tim-Philipp Müller
eee7aa5f15 docs: enable parallel build of subdirectories
We can build gtk docs, ADM, PWG and FAQ in parallel.
2014-02-09 16:47:53 +00:00
Sebastian Dröge
a00cc4338a manual: Fix build by using the correct C file name 2014-02-04 22:23:06 +01:00
Sebastian Dröge
b110286e95 manual: Clean up code a bit to be suitable for the docs 2014-02-04 21:36:18 +01:00
Todd Agulnick
cb1657fcea manual: Replace manual's effectswitch.c with newer test-effect-switch.c
https://bugzilla.gnome.org/show_bug.cgi?id=721100
2014-02-04 21:35:12 +01:00
Stefan Sauer
f6d638153c docs: fix more gtk-doc warnings 2014-02-01 16:18:13 +01:00
Stefan Sauer
b06e86fb18 docs: unhide docs for allocator
Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
2014-01-31 08:36:55 +01:00
Stefan Sauer
6b5ccf31aa part-toc: emphasize that the later chapters are design draft ideas 2014-01-29 22:48:04 +01:00
Stefan Sauer
bdb1f268a6 part-toc: add format specific information 2014-01-29 20:37:34 +01:00
Thiago Santos
5880c9c4c3 docs: design: add part-seqnums
Hopefully clarifies how seqnums should be used and copied from
events to events/messages when those are handled.

https://bugzilla.gnome.org/show_bug.cgi?id=722791
2014-01-24 09:31:44 -03:00
Nicolas Dufresne
ba7de077fb doc: Update sections with the new rounding macros 2014-01-14 16:22:31 -05:00
Stefan Sauer
4f70bd5a5a docs: ensure GstBufferPools shows up as with GObject features
GstBufferPool is a GstObject, add the _get_type function to the types file.
2014-01-13 20:51:03 +01:00
Stefan Sauer
fb2140b627 design/part-toc.txt: update design docs 2014-01-02 20:18:36 +01:00
Erik Andresen
2cbab400b2 docs: fix memory leak of appsink example in manual
https://bugzilla.gnome.org/show_bug.cgi?id=721076
2013-12-26 11:21:29 +00:00
William Jon McCann
26df7fa26d docs: fix project links
https://bugzilla.gnome.org/show_bug.cgi?id=720665
2013-12-18 11:43:35 +00:00
Tim-Philipp Müller
d92361ba52 docs: moving plugins: minor 0.10 -> 1.0 fix
Spotted by Jay Fenlason
2013-12-13 22:52:05 +00:00
Sebastian Rasmussen
53ae1b2c9c docs: Fix typos in function/object descriptions
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=720029
2013-12-07 17:11:12 +00:00
Sebastian Rasmussen
249a775d2b docs: add missing files for distribution
* add some documentation files in docs/design
 * add docs/list-ulink.xsl so check in docs/manual works

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=719814
2013-12-03 23:50:36 +00:00
Sebastian Rasmussen
49950e57ad docs: add missing docs, fixing doc errors
* add many missing declarations to sections
 * GstController has been removed, update docs
 * skip GstIndex when generating documentation
 * rephrase so gtkdoc doesn't imagine return value
 * add missing argument description for gst_context_new()
 * document GstOutputSelectorPadNegotiationMode and move to header-file

https://bugzilla.gnome.org/show_bug.cgi?id=719614
2013-12-03 00:11:59 +00:00
Wim Taymans
02b64ee03b systemclock: Add gst_system_clock_set_default
Used for setting the default system clock that is obtained through
gst_system_clock_obtain(), which is sometimes needed for unit
testing.

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=711269
2013-11-11 12:25:14 +01:00
Reynaldo H. Verdejo Pinochet
a3431f5d8b docs: fix common typos emited/eachother/... 2013-10-31 16:28:06 -07:00
Antonio Ospite
c76aaaaa1d pwg: rename the "samplerate" variable to make example code compilable
In one of the examples about gst_my_filter_setcaps() there is a variable
declared as "rate", but then the name "samplerate" is used when setting
the caps.

Use the name "rate" everywhere in gst_my_filter_setcaps().

https://bugzilla.gnome.org/show_bug.cgi?id=710876
2013-10-30 18:46:37 +01:00
Fabian Kirsch
4ceeee9ff8 doc: fix forward reference about ghost pads
https://bugzilla.gnome.org/show_bug.cgi?id=711089
2013-10-29 22:06:31 +00:00
Tim-Philipp Müller
40872f26ae docs: design: fix some fixes 2013-10-28 12:55:19 +00:00
Tim-Philipp Müller
20c2008ef8 docs: flesh out gst-uninstalled entry in faq some more
https://bugzilla.gnome.org/show_bug.cgi?id=709916
2013-10-26 09:48:06 +01:00
Fabian Kirsch
d0dd23cf9f docs: FAQ update to mention create-uninstalled-setup.sh
https://bugzilla.gnome.org/show_bug.cgi?id=709916
2013-10-26 09:41:26 +01:00
Stefan Sauer
0089bcd3e2 design: flesh out the tracing design a little more 2013-10-25 20:05:03 +02:00
Reynaldo H. Verdejo Pinochet
941cfd14d5 docs: Gram and nit fixes for part-meta.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
8a7ad85b23 docs: Gram and nit fixes for part-element-source.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
4d3b1d1558 docs: Gram and nit fixes for part-sink.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
a6b018a3bc docs: Gram and nit fixes for part-conventions.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
3abad71867 docs: Gram and nit fixes for part-controller.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
e6dda14148 docs: Gram and nit fixes for part-context.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
11503e4b3f docs: Gram and nit fixes for part-clocks.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
3d693f387f docs: Gram and nit fixes for part-caps.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
72edc18465 docs: Gram and nit fixes for part-buffer.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
20c32ffbdf docs: Gram and nit fixes for part-bufferpool.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
06a79347f3 docs: Gram and nit fixes for part-buffering.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
52810aa6ee docs: Gram and nit fixes for part-messages.txt 2013-10-24 12:06:01 -07:00
Reynaldo H. Verdejo Pinochet
eb57390198 docs: Gram and nit fixes for part-memory.txt 2013-10-24 12:06:01 -07:00
Thibault Saunier
8a5adf9c68 docs: Add gst_pad_store_sticky_event to sections.txt
So it appears in the generated documentation
2013-10-14 18:08:55 -03:00
Reynaldo H. Verdejo Pinochet
94a3394edf core: Fix max DEBUG_LEVEL incongruence on 5 vs 9
In the docs and the autocompletion logic the maximum
value jumped incongruently between 5 and 9.
2013-10-10 13:06:14 -07:00
Fabian Kirsch
0db5ae7962 docs: Fix some reference URIs
https://bugzilla.gnome.org/show_bug.cgi?id=709804
2013-10-10 13:15:45 +02:00
Tim-Philipp Müller
89ae3c2a82 docs: fix function name in qos design docs 2013-10-05 10:09:00 +01:00