From: Thomas Vander Stichele <thomas@apestaart.org>
Date: Wed, 1 Feb 2006 08:27:24 +0000 (+0000)
Subject: updates for plugin docs
X-Git-Tag: RELEASE-0_10_3~25
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e8e9419823d43826d91b6f8bfefd0dc22fdb6a42;p=platform%2Fupstream%2Fgstreamer.git

updates for plugin docs

Original commit message from CVS:
updates for plugin docs
---

diff --git a/docs/README b/docs/README
index e27affe..68d5a21 100644
--- a/docs/README
+++ b/docs/README
@@ -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