Add support for wxRibbonBar and related controls to XRC.

[wxWidgets.git] / docs / doxygen / mainpages / utilities.h

diff --git a/docs/doxygen/mainpages/utilities.h b/docs/doxygen/mainpages/utilities.h
index cd8bab34b97d3a22b2876bad01cce0edf3fd7ee6..a332e155776d9a9b1de2f08cd0909076345aed2c 100644 (file)
--- a/docs/doxygen/mainpages/utilities.h
+++ b/docs/doxygen/mainpages/utilities.h
@@ -3,16 +3,16 @@
 // Purpose:     Utilities page of the Doxygen manual
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // 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

 
 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
 
 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
 little use to others).
 
 Please note that these utilities do represent only the utilities developed


@@ -22,10 +22,9 @@ 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
 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_helpview
 @li @ref page_utils_hhp2cached

-@li @ref page_utils_tex2rtf
+@li @ref page_utils_ifacecheck

 @li @ref page_utils_wxrc
 
 
 @li @ref page_utils_wxrc
 
 


@@ -42,19 +41,10 @@ Xnest-based display emulator for X11-based PDA applications.
 This program can be found in @c utils/emulator.
 
 
 This program can be found in @c utils/emulator.
 
 

-@section page_utils_helpgen Helpgen
+@section page_utils_helpview Help Viewer

 
 

-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 Helpview
-
-Helpview is a program for displaying wxWidgets HTML
-Help files. In many cases, you may wish to use the wxWidgets HTML
+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.
 
 Help classes from within your application, but this provides a
 handy stand-alone viewer. See @ref overview_html for more details.
 


@@ -67,21 +57,27 @@ 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.
 
 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_tex2rtf Tex2RTF
+@section page_utils_ifacecheck Interface checker

 
 

-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 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.

 
 

-You can find it under @c utils/tex2rtf.
+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.

 
 

-@section page_utils_wxrc WxRC
+You can find it in @c utils/ifacecheck.
+
+
+@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.
 
 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.


@@ -89,5 +85,5 @@ See @ref overview_xrc for more info.
 
 You can find it under @c utils/wxrc.
 
 
 You can find it under @c utils/wxrc.
 

-

 */
 */

+