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.gir from here..
  11 https://github.com/roojs/gir-1.2-gtk-3.0/blob/master/GIRepository-2.0.gir
  12 g-ir-compile GIRepository-2.0.gir -o GIRepository-2.0.typelib
  13
  14
  15 -----------------------------
  16
  17
  18 run:
  19 seed docs.js /var/www
  20
  21 outputs to /var/www/seed
  22 ** if you have templates for other languages they will be output into /var/www/LANG
  23
  24 ----------------------------
  25 Licence:
  26 JSDOC code based on http://code.google.com/p/jsdoc-toolkit/ : MIT Licence
  27 Introspection - LGPL
  28
  29 ** FIXME - put the licence headers in the code.!
  30 ---------------------------
  31
  32 TODO list:
  33 - Work out how to host the bugger..
  34 - More libraries (related to gobject-introspection hacking)
  35 - Better documentation - we probably have to manually generate GIR's from source for this, as we have a 'special' doc requirement
  36 - add gir builder script (chroot/jhbuild..)
  37
  38