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 make a copy of /usr/lib/girepoistory-1.0/GIRepository-2.0.typelib
  15 copy that over it.
  16
  17
  18
  19 -----------------------------
  20
  21
  22 run:
  23 seed docs.js /var/www
  24
  25 outputs to /var/www/seed
  26 ** if you have templates for other languages they will be output into /var/www/LANG
  27
  28 ----------------------------
  29 Licence:
  30 JSDOC code based on http://code.google.com/p/jsdoc-toolkit/ : MIT Licence
  31 Introspection - LGPL
  32
  33 ** FIXME - put the licence headers in the code.!
  34 ---------------------------
  35
  36 TODO list:
  37 - Work out how to host the bugger..
  38 - More libraries (related to gobject-introspection hacking)
  39 - Better documentation - we probably have to manually generate GIR's from source for this, as we have a 'special' doc requirement
  40 - add gir builder script (chroot/jhbuild..)
  41
  42