wxWidgets

History

Kelvin Lee c4f6cf21dc Use canonical format for MSVS project/solution files Use the same format as is used by MSVS itself to avoid spurious changes when modifying the files. Notably: - Use DOS end of line format (0D 0A). - Add UTF-8 BOM (EF BB BF) to the beginning of the files. - Do not put CR LF at the end of the last line in the file. Closes https://github.com/wxWidgets/wxWidgets/pull/440		2017-03-18 15:14:26 +01:00
..
src	Use canonical format for MSVS project/solution files	2017-03-18 15:14:26 +01:00
gccxml.dtd	added the rungccxml.sh script and the setup_gccxml.h file to make it easier to generate the gccxml output for ifacecheck	2008-03-26 16:40:54 +00:00
gccxml.xsl	added the rungccxml.sh script and the setup_gccxml.h file to make it easier to generate the gccxml output for ifacecheck	2008-03-26 16:40:54 +00:00
README.txt	Fixed various typos.	2011-03-22 14:17:38 +00:00
rungccxml.sh.in	Remove all lines containing cvs/svn "$Id$" keyword.	2013-07-26 16:02:46 +00:00

README.txt

 Ifacecheck utility
 ==================

 1) INTRODUCTION

 This utility compares the wxWidgets real interface contained in the "include"
 hierarchy with the wxWidgets interface used for documentation purposes and
 kept in the "interface" hierarchy.

 Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
 can even correct them automatically. It uses the XML outputs of the gccxml utility
 (see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
 to do the comparison.

 It's explicitly designed for wxWidgets documentation needs and is probably of little
 use for anything else than wxWidgets docs reviewing.


 2) PREREQUISITES FOR USING IT

 To use this utility you'll need at least:
  - wxWidgets "include" and "interface" headers tree
  - Doxygen installed
  - Gccxml installed


 3) HOW TO USE IT (on Linux)

    First, create the doxygen XML:

     > cd docs/doxygen
     > ./regen.sh xml
     > cd ../..

    Next, create the gcc XML:

     > ./configure                # configure wxWidgets as you would do when building it
     > cd utils/ifacecheck
     > ./rungccxml.sh
     > cd ../..

    Last, build and run ifacecheck:

     > cd utils/ifacecheck/src
     > make
     > make install
     > cd ..
     > ifacecheck -u wxapi-preproc.txt wxapi.xml ../../docs/doxygen/out/xml/index.xml >ifacecheck.log

    Now you should have the log of the utility saved in 'ifacecheck.log'.
    Its contents should be easy to interpret.

    For more info about ifacecheck options just type:
     > ifacecheck --help