Original commit message from CVS:
readme
This commit is contained in:
Thomas Vander Stichele 2003-09-11 10:47:32 +00:00
parent 7af246f2ef
commit d494eef5a7

23
docs/README Normal file
View file

@ -0,0 +1,23 @@
GTK-DOC stuff
-------------
* starting files in CVS:
- Makefile.am
- gstreamer-sections.txt, gstreamer.types.in, gstreamer-docs.sgml
- tmpl/
* what is done in the gst dir ?
- headers are scanned based on $(MODULE).types
$(MODULE)-scan is created
gtkdoc-scan is called with a sourcedir and a module name,
where the module name is $(MODULE)
$(MODULE)-sections.txt is created if it doesn't exist yet (it should),
as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt
and .args, .hierarchy and .signals files are created
gtkdoc-scan is called
* TODO:
why is there gstreamer.types.in and gst-plugins.types.in ?