| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990 |
- /////////////////////////////////////////////////////////////////////////////
- // Name: utilities.h
- // Purpose: Utilities page of the Doxygen manual
- // Author: wxWidgets team
- // Licence: wxWindows licence
- /////////////////////////////////////////////////////////////////////////////
- /**
- @page page_utils Utilities Overview
- @tableofcontents
- In addition to the wxWidgets libraries (see @ref page_libs), some utilities
- are available to the users in the @c utils hierarchy (even if some of them are
- explicitly conceived for wxWidgets maintainance and will probably be of
- little use to others).
- Please note that these utilities do represent only the utilities developed
- and maintained by the wxWidgets team.
- There are lots of other user-contributed and user-maintained packages;
- see the wxWidgets download page: http://www.wxwidgets.org/downloads
- or directly http://wxcode.sourceforge.net or http://www.wxcommunity.com/ .
- @section page_utils_emulator Emulator
- Xnest-based display emulator for X11-based PDA applications.
- <!-- On some systems, the Xnest window does not synchronise with the
- 'skin' window. THIS ISN'T THE PLACE FOR THIS STATEMENT I THINK -->
- This program can be found in @c utils/emulator.
- @section page_utils_helpview Help Viewer
- Helpview is a program for displaying wxWidgets HTML Help files.
- In many cases, you may wish to use the wxWidgets HTML
- Help classes from within your application, but this provides a
- handy stand-alone viewer. See @ref overview_html for more details.
- You can find Helpview in @c utils/helpview.
- @section page_utils_hhp2cached HHP2Cached
- This utility creates a "cached" version of a @c .hhp file; using cached @c .hhp
- files in wxHtmlHelpController can dramatically improve the performance
- of the help viewer. See wxHtmlHelpController for more details.
- You can find HHP2Cached in @c utils/hhp2cached.
- @section page_utils_ifacecheck Interface Checker
- This utility compares the wxWidgets real interface contained in the @c include
- hierarchy with the wxWidgets interface used for documentation purposes and
- kept in the @c 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 comparisons.
- It's explicitly designed for wxWidgets documentation needs and is probably of little
- use for anything else than wxWidgets docs reviewing.
- You can find it in @c utils/ifacecheck.
- @section page_utils_screenshotgen Screenshot Generator
- This utility automates the process of taking screenshots of various GUI
- components for use in the HTML documentation of wxWidgets.
- You can find it in @c utils/screenshotgen.
- @section page_utils_wxrc wxWidgets XML Resource Compiler
- This utility allows the user to compile @e binary versions of their XRC files,
- which are compressed and can be loaded faster than plain XRC files.
- See @ref overview_xrc for more info.
- You can find it under @c utils/wxrc.
- */
|
