wxWidgets

History

Vadim Zeitlin 5216d97f08 Use arch suffix consistently in all directories names For some reason, we used "vc_x64_lib" as the output directory for the libraries, but "vc_mswu_x64" as the output directory for the samples. Place the arch suffix, i.e. "_x64" part, always after the compiler prefix (possibly including version), for consistency with both the library output directories and with MSBuild project files, as build/msw/wx_setup.props uses $(wxCompilerPrefix)$(wxArchSuffix)_... as wxIntRootDir value.		2021-08-26 23:12:40 +02:00
..
src	Use arch suffix consistently in all directories names	2021-08-26 23:12:40 +02:00
gccxml.dtd
gccxml.xsl
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