| | 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 Included Utilities |
| | 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_helpview |
| | 26 | @li @ref page_utils_hhp2cached |
| | 27 | @li @ref page_utils_ifacecheck |
| | 28 | @li @ref page_utils_wxrc |
| | 29 | |
| | 30 | |
| | 31 | <hr> |
| | 32 | |
| | 33 | |
| | 34 | @section page_utils_emulator Emulator |
| | 35 | |
| | 36 | Xnest-based display emulator for X11-based PDA applications. |
| | 37 | |
| | 38 | <!-- On some systems, the Xnest window does not synchronise with the |
| | 39 | 'skin' window. THIS ISN'T THE PLACE FOR THIS STATEMENT I THINK --> |
| | 40 | |
| | 41 | This program can be found in @c utils/emulator. |
| | 42 | |
| | 43 | |
| | 44 | @section page_utils_helpview Help Viewer |
| | 45 | |
| | 46 | Helpview is a program for displaying wxWidgets HTML Help files. |
| | 47 | In many cases, you may wish to use the wxWidgets HTML |
| | 48 | Help classes from within your application, but this provides a |
| | 49 | handy stand-alone viewer. See @ref overview_html for more details. |
| | 50 | |
| | 51 | You can find Helpview in @c utils/helpview. |
| | 52 | |
| | 53 | |
| | 54 | @section page_utils_hhp2cached HHP2Cached |
| | 55 | |
| | 56 | This utility creates a "cached" version of a @c .hhp file; using cached @c .hhp |
| | 57 | files in wxHtmlHelpController can drammatically improve the performances |
| | 58 | of the help viewer. See wxHtmlHelpController for more details. |
| | 59 | |
| | 60 | You can find HHP2Cached in @c utils/hhp2cached. |
| | 61 | |
| | 62 | |
| | 63 | @section page_utils_ifacecheck Interface checker |
| | 64 | |
| | 65 | This utility compares the wxWidgets real interface contained in the @c include |
| | 66 | hierarchy with the wxWidgets interface used for documentation purposes and |
| | 67 | kept in the @c interface hierarchy. |
| | 68 | |
| | 69 | Ifacecheck warns about incoherences (mainly wrong prototype signatures) and |
| | 70 | can even correct them automatically. It uses the XML outputs of the gccxml utility |
| | 71 | (see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org) |
| | 72 | to do the comparisons. |
| | 73 | |
| | 74 | It's explicitely designed for wxWidgets documentation needs and is probably of little |
| | 75 | use for anything else than wxWidgets docs reviewing. |
| | 76 | |
| | 77 | You can find it in @c utils/ifacecheck. |
| | 78 | |
| | 79 | |
| | 80 | @section page_utils_wxrc wxWidgets XML Resource Compiler |
| | 81 | |
| | 82 | This utility allows the user to compile @e binary versions of their XRC files, |
| | 83 | which are compressed and can be loaded faster than plain XRC files. |
| | 84 | See @ref overview_xrc for more info. |
| | 85 | |
| | 86 | You can find it under @c utils/wxrc. |
| | 87 | |
| | 88 | */ |
| | 89 | |
projects / wxWidgets.git / blame_incremental