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.
This commit is contained in:
Jan Schmidt 2008-05-17 17:20:51 +00:00
parent 2aab2757c0
commit 450fa6366a
4 changed files with 26 additions and 2 deletions

View file

@ -1,3 +1,13 @@
2008-05-17 Jan Schmidt <jan.schmidt@sun.com>
* 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 Sebastian Dröge <slomo@circular-chaos.org>
* gst/gstmessage.c: (gst_message_new_error),

2
common

@ -1 +1 @@
Subproject commit 3b3631082d04b426f450810e8836de94e9c5d60a
Subproject commit e365978c480a8fffa4bdb61568fb2cd989d1b197

View file

@ -4,9 +4,15 @@ else
SUBDIRS_DOCBOOK =
endif
if ENABLE_PLUGIN_DOCS
PLUGIN_DOCS_DIRS = plugins
else
PLUGIN_DOCS_DIRS =
endif
BUILT_SOURCES = version.entities
SUBDIRS = design gst libs plugins $(SUBDIRS_DOCBOOK)
SUBDIRS = design gst libs $(PLUGIN_DOCS_DIRS) $(SUBDIRS_DOCBOOK)
DIST_SUBDIRS = design gst libs plugins faq manual pwg slides xsl
EXTRA_DIST = \

View file

@ -242,6 +242,14 @@ in the various plugin packages.
cvs add *-plugins-docs.sgml *-plugins.args *-plugins.hierarchy *-plugins.interfaces *-plugins.prerequisites *-plugins.signals *-plugins.types inspect-build.stamp inspect.stamp scanobj-build.stamp
cvs add inspect
cvs add inspect/*.xml
- Additional types can be added to the documentation by placing them in
the .types file like this:
type:GstPlayBaseBin
This is useful for documenting plugin-private types that implement
signals or properties. The GType is looked up by name after all the
element classes have been printed - so this is only useful for types
that are created as a consequence of loading plugins and registering
the element(s).
- to add a plugin to be documented:
- make sure inspect/ has generated a inspect/plugin-xxx.xml file for it.