git.saurik.com Git - wxWidgets.git/blame_incremental - docs/doxygen/mainpages/utilities.h

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: utilities.h
	3	// Purpose: Utilities page of the Doxygen manual
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10
	11	@page page_utils Utilities Overview
	12
	13	@tableofcontents
	14
	15	In addition to the wxWidgets libraries (see @ref page_libs), some utilities
	16	are available to the users in the @c utils hierarchy (even if some of them are
	17	explicitly conceived for wxWidgets maintainance and will probably be of
	18	little use to others).
	19
	20	Please note that these utilities do represent only the utilities developed
	21	and maintained by the wxWidgets team.
	22	There are lots of other user-contributed and user-maintained packages;
	23	see the wxWidgets download page: http://www.wxwidgets.org/downloads
	24	or directly http://wxcode.sourceforge.net or http://www.wxcommunity.com/ .
	25
	26
	27
	28	@section page_utils_emulator Emulator
	29
	30	Xnest-based display emulator for X11-based PDA applications.
	31
	32	<!-- On some systems, the Xnest window does not synchronise with the
	33	'skin' window. THIS ISN'T THE PLACE FOR THIS STATEMENT I THINK -->
	34
	35	This program can be found in @c utils/emulator.
	36
	37
	38	@section page_utils_helpview Help Viewer
	39
	40	Helpview is a program for displaying wxWidgets HTML Help files.
	41	In many cases, you may wish to use the wxWidgets HTML
	42	Help classes from within your application, but this provides a
	43	handy stand-alone viewer. See @ref overview_html for more details.
	44
	45	You can find Helpview in @c utils/helpview.
	46
	47
	48	@section page_utils_hhp2cached HHP2Cached
	49
	50	This utility creates a "cached" version of a @c .hhp file; using cached @c .hhp
	51	files in wxHtmlHelpController can drammatically improve the performances
	52	of the help viewer. See wxHtmlHelpController for more details.
	53
	54	You can find HHP2Cached in @c utils/hhp2cached.
	55
	56
	57	@section page_utils_ifacecheck Interface Checker
	58
	59	This utility compares the wxWidgets real interface contained in the @c include
	60	hierarchy with the wxWidgets interface used for documentation purposes and
	61	kept in the @c interface hierarchy.
	62
	63	Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
	64	can even correct them automatically. It uses the XML outputs of the gccxml utility
	65	(see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
	66	to do the comparisons.
	67
	68	It's explicitly designed for wxWidgets documentation needs and is probably of little
	69	use for anything else than wxWidgets docs reviewing.
	70
	71	You can find it in @c utils/ifacecheck.
	72
	73
	74	@section page_utils_screenshotgen Screenshot Generator
	75
	76	This utility automates the process of taking screenshots of various GUI
	77	components for use in the HTML documentation of wxWidgets.
	78
	79	You can find it in @c utils/screenshotgen.
	80
	81
	82	@section page_utils_wxrc wxWidgets XML Resource Compiler
	83
	84	This utility allows the user to compile @e binary versions of their XRC files,
	85	which are compressed and can be loaded faster than plain XRC files.
	86	See @ref overview_xrc for more info.
	87
	88	You can find it under @c utils/wxrc.
	89
	90	*/
	91