Mathieu Duponchelle
996743ed39
gst-hotdoc-plugins-scanner: serialize interfaces
2020-06-23 11:58:56 -04:00
Mathieu Duponchelle
8c753a30e5
gst-hotdoc-plugins-scanner: don't instantiate base classes
2020-06-23 11:58:56 -04:00
Mathieu Duponchelle
ef86d00ba9
gst-hotdoc-plugins-scanner: serialize parents in hierarchy when needed
2020-06-23 11:58:56 -04:00
Thibault Saunier
1152fb33a4
docs: Document signals and properties only for current type
2020-06-23 11:58:55 -04:00
Thibault Saunier
34db244d46
docs: Fix the way we mark properties mutability
...
When nothing is specified, we should default to NULL, not PLAYING
2020-06-10 13:37:08 +00:00
Seungha Yang
c092dd40ca
doc: Add GstObject specific GParamFlags
...
Document "controllable", "mutable-{ready, paused, playing}" and
"conditonally-available" GParamFlags
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/283 >
2020-06-08 14:18:09 +00:00
Sebastian Dröge
5e8e847687
docs: Prevent potential NULL pointer dereference when serializing plugin object types
...
CID 1464007
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/516 >
2020-06-06 08:14:39 +00:00
Mathieu Duponchelle
169abc86e9
padtemplate: expose getters and setters "documentation caps"
...
This can be used in elements where the caps of pad templates
are dynamically generated and dependent on the environment.
An example is x265enc.
2020-06-06 00:38:29 +02:00
Mathieu Duponchelle
0c1ce6e8c4
utils: expose GstPluginAPIFlags
...
These can be passed to gst_type_mark_as_plugin_api, to inform
plugin cache generation.
For now a single flag is specified, "IGNORE_ENUM_MEMBERS", it
can be used for dynamically generated enums to avoid documenting
environment-specific enumeration members. An example is
GstX265EncTune.
2020-06-06 00:38:29 +02:00
Sebastian Dröge
6e50c6c6fb
docs: Don't include GObject and GstPipeline signals
...
They're already documented from elsewhere.
2020-06-04 15:49:24 -04:00
Sebastian Dröge
65e266fe6e
docs: Store all non-element types in a separate other-types array
...
And also make sure to not duplicate them.
2020-06-04 15:49:24 -04:00
Sebastian Dröge
994d74faf4
docs: Use gst_type_is_plugin_api() for deciding whether a type should be included in the docs
2020-06-04 15:49:24 -04:00
Sebastian Dröge
b705ab4de6
docs: Don't try to print pad templates of non-GstElement types
2020-06-04 15:49:23 -04:00
Sebastian Dröge
8e28799303
docs: Print object/flag/enum type information in a more structured way and in more places
...
Custom types are printed now for signal parameters/return value and properties, and more consistently.
Fixes https://gitlab.freedesktop.org/gstreamer/gst-docs/-/issues/59
2020-06-04 15:49:23 -04:00
Sebastian Dröge
d0e430a690
docs: Add boolean field for readability of properties
...
Some properties are write-only.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/496 >
2020-05-20 12:02:08 +00:00
Sebastian Dröge
a3562b0d2a
docs: Add list of interfaces implemented by elements to the docs
...
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/486 >
2020-05-15 11:46:28 +00:00
Thibault Saunier
416d4a13e0
doc: Add signal flags information in the plugin cache
...
Updating the plugin cache file
Same behavior as g-ir as the signal flags don't have a GType associated.
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/463 >
2020-05-05 13:40:50 -04:00
Sebastian Dröge
ed1022fa81
Use gst_object_unref() / gst_object_clear() instead of the GObject ones
...
To allow the refcounting tracer to work better. In childproxy/iterator
these might be plain GObjects but gst_object_unref() also works on them.
In other places where it is never GstObject, g_object_unref() is kept.
2020-04-20 16:28:52 +00:00
Thibault Saunier
06e54399ba
hotdoc: Add missing json escaping
...
Fixes https://gitlab.freedesktop.org/gstreamer/gst-docs/issues/50
2019-11-13 11:37:22 +00:00
Thibault Saunier
f040102d45
docs: Add tracers support
2019-05-31 18:53:43 -04:00
Thibault Saunier
3635a6a98b
docs: Document pad types
...
And update the plugins doc cache
2019-05-25 10:56:50 -04:00
Thibault Saunier
042f6d5def
docs: Update diplayed plugins filename something stable
2019-05-16 18:22:20 +00:00
Thibault Saunier
6009b82d65
hotdoc: Let the the registry inspect in forks
...
So that the whole process doesn't segfault if something bad happens while inspecting
2019-05-16 18:22:20 +00:00
Thibault Saunier
56d01406bc
docs: Do not pass the json through stdout
...
Unicode encoding breaks on windows when doing so
2019-05-16 18:22:20 +00:00
Thibault Saunier
a0c65067e0
Port to hotdoc
2019-05-13 16:34:09 -04:00
