docs/README

   1 GTK-DOC stuff
   2 -------------
   3
   4 * starting files in CVS:
   5   - Makefile.am
   6   - gstreamer-sections.txt, gstreamer.types.in, gstreamer-docs.sgml
   7   - tmpl/
   8
   9 * what is done in the gst dir ?
  10
  11 - headers are scanned based on $(MODULE).types
  12   $(MODULE)-scan is created
  13   gtkdoc-scan is called with a sourcedir and a module name,
  14   where the module name is  $(MODULE)
  15   $(MODULE)-sections.txt is created if it doesn't exist yet (it should),
  16   as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt
  17
  18   and .args, .hierarchy and .signals files are created
  19   gtkdoc-scan is called
  20
  21
  22 * TODO:
  23   why is there gstreamer.types.in and gst-plugins.types.in ?