docs/doxygen/mainpages/utilities.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        utilities.h
   3 // Purpose:     Utilities page of the Doxygen manual
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10
  11 @page page_utils Utilities supplied with wxWidgets
  12
  13 In addition to the wxWidgets libraries (see @ref page_libs), some utilities
  14 are available to the users in the @c utils hierarchy (even if some of them are
  15 explicitely coinceived for wxWidgets maintainance and will probably be of
  16 little use to others).
  17
  18 Please note that these utilities do represent only the utilities developed
  19 and maintained by the wxWidgets team.
  20 There are lots of other user-contributed and user-maintained packages;
  21 see the wxWidgets download page: http://www.wxwidgets.org/downloads
  22 or directly http://wxcode.sourceforge.net or http://www.wxcommunity.com/ .
  23
  24 @li @ref page_utils_emulator
  25 @li @ref page_utils_helpgen
  26 @li @ref page_utils_helpview
  27 @li @ref page_utils_hhp2cached
  28 @li @ref page_utils_ifacecheck
  29 @li @ref page_utils_tex2rtf
  30 @li @ref page_utils_wxrc
  31
  32
  33 <hr>
  34
  35
  36 @section page_utils_emulator Emulator
  37
  38 Xnest-based display emulator for X11-based PDA applications.
  39
  40 <!-- On some systems, the Xnest window does not synchronise with the
  41 'skin' window. THIS ISN'T THE PLACE FOR THIS STATEMENT I THINK -->
  42
  43 This program can be found in @c utils/emulator.
  44
  45
  46 @section page_utils_helpgen Help Generator
  47
  48 Helpgen takes C++ header files and generates a Tex2RTF-compatible
  49 documentation file for each class it finds, using comments as appropriate.
  50 This is a good way to start a reference for a set of classes.
  51
  52 Helpgen can be found in @c utils/HelpGen.
  53
  54
  55 @section page_utils_helpview Help Viewer
  56
  57 Helpview is a program for displaying wxWidgets HTML Help files.
  58 In many cases, you may wish to use the wxWidgets HTML
  59 Help classes from within your application, but this provides a
  60 handy stand-alone viewer. See @ref overview_html for more details.
  61
  62 You can find Helpview in @c utils/helpview.
  63
  64
  65 @section page_utils_hhp2cached HHP2Cached
  66
  67 This utility creates a "cached" version of a @c .hhp file; using cached @c .hhp
  68 files in wxHtmlHelpController can drammatically improve the performances
  69 of the help viewer. See wxHtmlHelpController for more details.
  70
  71 You can find HHP2Cached in @c utils/hhp2cached.
  72
  73
  74 @section page_utils_ifacecheck Interface checker
  75
  76 This utility compares the wxWidgets real interface contained in the @c include
  77 hierarchy with the wxWidgets interface used for documentation purposes and
  78 kept in the @c interface hierarchy.
  79
  80 Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
  81 can even correct them automatically. It uses the XML outputs of the gccxml utility
  82 (see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
  83 to do the comparisons.
  84
  85 You can find it in @c utils/ifacecheck.
  86
  87
  88 @section page_utils_tex2rtf Tex2RTF
  89
  90 Supplied with wxWidgets is a utility called Tex2RTF for
  91 converting @e LaTeX manuals HTML, MS HTML Help, wxHTML Help, RTF, and Windows
  92 Help RTF formats. Tex2RTF was used for the wxWidgets manuals and can be used
  93 independently by authors wishing to create on-line and printed manuals from the
  94 same @e LaTeX source. Please see the separate documentation for Tex2RTF.
  95
  96 You can find it under @c utils/tex2rtf.
  97
  98
  99 @section page_utils_wxrc wxWidgets XML Resource Compiler
 100
 101 This utility allows the user to compile @e binary versions of their XRC files,
 102 which are compressed and can be loaded faster than plain XRC files.
 103 See @ref overview_xrc for more info.
 104
 105 You can find it under @c utils/wxrc.
 106
 107
 108 */