]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/utilities.h
forgot to commit these -- were part of devtips.h
[wxWidgets.git] / docs / doxygen / utilities.h
diff --git a/docs/doxygen/utilities.h b/docs/doxygen/utilities.h
new file mode 100644 (file)
index 0000000..5053ae8
--- /dev/null
@@ -0,0 +1,41 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        utilities.h
+// Purpose:     Utilities page of the Doxygen manual
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/*!
+
+ @page utilities_page Utilities and libraries supplied with wxWidgets
+
+ In addition to the @ref librarieslist, some
+ additional utilities are supplied in the @c utils hierarchy.
+
+ For other user-contributed packages, please see the Contributions page
+ on the wxWidgets Web site http://www.wxwidgets.org.
+
+ @li @b Helpview: 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 html_overview for more details.
+ You can find it in @c samples/html/helpview.
+
+ @li @b Tex2RTF; 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.
+ You can find it under @c utils/tex2rtf.
+
+ @li @b Helpgen: 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.
+
+ @li @b Emulator: Xnest-based display emulator for X11-based PDA applications.
+ On some systems, the Xnest window does not synchronise with the
+ 'skin' window. This program can be found in @c utils/emulator.
+
+*/