git.roojs.org Git - gnome.introspection-doc-generator/blob - README.txt

   1 docs generator for gobject-introspection
   2
   3 Requires seed
   4
   5 -----------------------------
   6
   7 Known issues:
   8 GArgument does not get exported correctly by introspection.
   9
  10 Use the girepository from here..
  11
  12
  13 -----------------------------
  14
  15
  16 run:
  17 seed docs.js /var/www
  18
  19 outputs to /var/www/seed
  20 ** if you have templates for other languages they will be output into /var/www/LANG
  21
  22 ----------------------------
  23 Licence:
  24 JSDOC code based on http://code.google.com/p/jsdoc-toolkit/ : MIT Licence
  25 Introspection - LGPL
  26
  27 ** FIXME - put the licence headers in the code.!
  28 ---------------------------
  29
  30 TODO list:
  31 - Work out how to host the bugger..
  32 - More libraries (related to gobject-introspection hacking)
  33 - Better documentation - we probably have to manually generate GIR's from source for this, as we have a 'special' doc requirement
  34 - add gir builder script (chroot/jhbuild..)
  35
  36