diff options
| author | Jan Schmidt <thaytan@mad.scientist.com> | 2008-05-17 17:20:51 +0000 |
|---|---|---|
| committer | Jan Schmidt <thaytan@mad.scientist.com> | 2008-05-17 17:20:51 +0000 |
| commit | 450fa6366abc7c395141218621f806b9b4930fc7 (patch) | |
| tree | 2724ca2375a4607bfb5fb1885899b72e6f591f6a /docs/README | |
| parent | 2aab2757c0ee2594169f1fed1dcc1c8713467e65 (diff) | |
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.
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/README b/docs/README index a531204c2..ed6b37189 100644 --- a/docs/README +++ b/docs/README @@ -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. |