]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/mainpages/utilities.h
wxMessageBox off the main thread lost result code.
[wxWidgets.git] / docs / doxygen / mainpages / utilities.h
index a4b2b93343ae590a4f5ed5e75f5436981768289f..f3e9b00dfe0497dba4f4cb271a6c567bc45bbef7 100644 (file)
@@ -2,17 +2,18 @@
 // Name:        utilities.h
 // Purpose:     Utilities page of the Doxygen manual
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 
-@page page_utils Utilities supplied with wxWidgets
+@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
-explicitely coinceived for wxWidgets maintainance and will probably be of
+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
@@ -21,16 +22,6 @@ 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/ .
 
-@li @ref page_utils_emulator
-@li @ref page_utils_helpgen
-@li @ref page_utils_helpview
-@li @ref page_utils_hhp2cached
-@li @ref page_utils_ifacecheck
-@li @ref page_utils_tex2rtf
-@li @ref page_utils_wxrc
-
-
-<hr>
 
 
 @section page_utils_emulator Emulator
@@ -43,15 +34,6 @@ Xnest-based display emulator for X11-based PDA applications.
 This program can be found in @c utils/emulator.
 
 
-@section page_utils_helpgen Help Generator
-
-Helpgen takes C++ header files and generates a Tex2RTF-compatible
-documentation file for each class it finds, using comments as appropriate.
-This is a good way to start a reference for a set of classes.
-
-Helpgen can be found in @c utils/HelpGen.
-
-
 @section page_utils_helpview Help Viewer
 
 Helpview is a program for displaying wxWidgets HTML Help files.
@@ -68,10 +50,10 @@ This utility creates a "cached" version of a @c .hhp file; using cached @c .hhp
 files in wxHtmlHelpController can drammatically improve the performances
 of the help viewer. See wxHtmlHelpController for more details.
 
-You can find HHP2Cached in @c utils/helpview.
+You can find HHP2Cached in @c utils/hhp2cached.
 
 
-@section page_utils_ifacecheck Interface checker
+@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
@@ -82,18 +64,18 @@ can even correct them automatically. It uses the XML outputs of the gccxml utili
 (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_tex2rtf Tex2RTF
+@section page_utils_screenshotgen Screenshot Generator
 
-Supplied with wxWidgets is a utility called Tex2RTF for
-converting @e LaTeX manuals HTML, MS HTML Help, wxHTML Help, RTF, and Windows
-Help RTF formats. Tex2RTF was used for the wxWidgets manuals and can be used
-independently by authors wishing to create on-line and printed manuals from the
-same @e LaTeX source. Please see the separate documentation for Tex2RTF.
+This utility automates the process of taking screenshots of various GUI
+components for use in the HTML documentation of wxWidgets.
 
-You can find it under @c utils/tex2rtf.
+You can find it in @c utils/screenshotgen.
 
 
 @section page_utils_wxrc wxWidgets XML Resource Compiler
@@ -104,5 +86,5 @@ See @ref overview_xrc for more info.
 
 You can find it under @c utils/wxrc.
 
-
 */
+