utils/ifacecheck/README.txt

   1
   2  Ifacecheck utility
   3  ==================
   4
   5  1) INTRODUCTION
   6
   7  This utility compares the wxWidgets real interface contained in the "include"
   8  hierarchy with the wxWidgets interface used for documentation purposes and
   9  kept in the "interface" hierarchy.
  10
  11  Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
  12  can even correct them automatically. It uses the XML outputs of the gccxml utility
  13  (see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
  14  to do the comparison.
  15
  16  It's explicitely designed for wxWidgets documentation needs and is probably of little
  17  use for anything else than wxWidgets docs reviewing.
  18
  19
  20  2) PREREQUISITES FOR USING IT
  21
  22  To use this utility you'll need at least:
  23   - wxWidgets "include" and "interface" headers tree
  24   - Doxygen installed
  25   - Gccxml installed
  26
  27
  28  3) HOW TO USE IT (on Linux)
  29
  30     First, create the doxygen XML:
  31
  32      > cd docs/doxygen
  33      > ./regen.sh xml
  34      > cd ../..
  35
  36     Next, create the gcc XML:
  37
  38      > ./configure                # configure wxWidgets as you would do when building it
  39      > cd utils/ifacecheck
  40      > ./rungccxml.sh
  41      > cd ../..
  42
  43     Last, build and run ifacecheck:
  44
  45      > cd utils/ifacecheck/src
  46      > make
  47      > make install
  48      > cd ..
  49      > ifacecheck -u wxapi-preproc.txt wxapi.xml ../../docs/doxygen/out/xml/index.xml >ifacecheck.log
  50
  51     Now you should have the log of the utility saved in 'ifacecheck.log'.
  52     Its contents should be easy to interpret.
  53
  54     For more info about ifacecheck options just type:
  55      > ifacecheck --help