mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-03-30 12:49:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

updates for plugin docs

Browse source 
Original commit message from CVS:
updates for plugin docs
This commit is contained in:
Thomas Vander Stichele 2006-02-01 08:27:24 +00:00
parent b6192a81bd
commit e8e9419823
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/README
View file

@ -229,6 +229,19 @@ in the various plugin packages.
- in a submodule, docs go in docs/plugins
- template can be copied from gst-plugins-base
- to add plugins documentation:
- create docs/plugins
- create Makefile.am and friends, add to configure.ac
- create docs/version.entities.in, add to configure.ac
- in docs/plugins:
- create $(module)-plugins.types with #include <gst/gst.h>
- run make
- edit the -docs.sgml
- add to cvs:
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
- to add an element to be documented:
- add an include href in the Elements chapter for the element
in the main .sgml