Added the class group pages for Doxygen.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52464 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-13 02:56:21 +00:00
parent 96d7cc9be3
commit 6e7f563b52
35 changed files with 640 additions and 0 deletions

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_appmanagement.h
// Purpose: Application and Process Management classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_appmanagement Application and Process Management
@ingroup group_class
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_aui.h
// Purpose: Window Docking (wxAUI) classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_aui Window Docking (wxAUI)
@ingroup group_class
wxAUI is a set classes for writing a customizable application interface
with built-in docking, floatable panes and a flexible MDI-like interface.
Related Overviews: @ref overview_aui
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_cmndlg.h
// Purpose: Common Dialog classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_cmndlg Common Dialogs
@ingroup group_class
Common dialogs are ready-made dialog classes which are frequently used in an
application.
Related Overviews: @ref overview_cmndlg
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_containers.h
// Purpose: Container classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_containers Containers
@ingroup group_class
These are classes, templates and class macros are used by wxWidgets. Most of
these classes provide a subset or almost complete STL API.
Related Overviews: @ref overview_container
*/

View File

@@ -0,0 +1,18 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_ctrl.h
// Purpose: Control classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_ctrl Controls
@ingroup group_class
Typically, these are small windows which provide interaction with the user.
Controls that are not static can have wxValidator associated with them.
*/

View File

@@ -0,0 +1,17 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_data.h
// Purpose: Data Structure classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_data Data Structures
@ingroup group_class
These are the data structure classes provided by wxWidgets.
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_debugging.h
// Purpose: Debugging classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_debugging Debugging
@ingroup group_class
wxWidgets supports some aspects of debugging an application through classes,
functions and macros.
Related Overviews: @ref overview_debugging
*/

View File

@@ -0,0 +1,17 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_dnd.h
// Purpose: Clipboard and Drag & Drop classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_dnd Clipboard and Drag & Drop
@ingroup group_class
Related Overviews: @ref overview_dnd
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_docview.h
// Purpose: Document/View Framework classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_docview Document/View Framework
@ingroup group_class
wxWidgets supports a document/view framework which provides housekeeping for a
document-centric application.
Related Overviews: @ref overview_docview
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_events.h
// Purpose: Event classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_events Events
@ingroup group_class
An event object contains information about a specific event. Event handlers
(usually member functions) have a single, event argument.
Related Overviews: @ref overview_eventhandling
*/

View File

@@ -0,0 +1,19 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_file.h
// Purpose: File Handling classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_file File Handling
@ingroup group_class
wxWidgets has several small classes to work with disk files and directories.
Related Overviews: @ref overview_file
*/

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_gl.h
// Purpose: OpenGL classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_gl OpenGL
@ingroup group_class
*/

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_help.h
// Purpose: Help classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_help Help
@ingroup group_class
*/

View File

@@ -0,0 +1,18 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_html.h
// Purpose: HTML classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_html HTML
@ingroup group_class
wxWidgets provides a set of classes to display text in HTML format. These
classes include a help system based on the HTML widget.
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_ipc.h
// Purpose: Interprocess Communication classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_ipc Interprocess Communication
@ingroup group_class
wxWidgets provides simple interprocess communications facilities based on
Windows DDE, but available on most platforms using TCP.
Related Overviews: @ref overview_ipc
*/

View File

@@ -0,0 +1,19 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_logging.h
// Purpose: Logging classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_logging Logging
@ingroup group_class
wxWidgets provides several classes and functions for message logging.
Related Overviews: @ref overview_log
*/

View File

@@ -0,0 +1,21 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_managedwnd.h
// Purpose: Managed Windows classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_managedwnd Managed Windows
@ingroup group_class
There are several types of window that are directly controlled by the window
manager (such as MS Windows, or the Motif Window Manager). Frames and dialogs
are similar in wxWidgets, but only dialogs may be modal.
Related Overviews: @ref overview_cmndlg
*/

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_media.h
// Purpose: Multimedia classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_media Multimedia
@ingroup group_class
*/

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_menus.h
// Purpose: Menu classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_menus Menus
@ingroup group_class
*/

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_misc.h
// Purpose: Miscellaneous classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_misc Miscellaneous
@ingroup group_class
*/

View File

@@ -0,0 +1,17 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_miscwnd.h
// Purpose: Miscellaneous Windows classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_miscwnd Miscellaneous Windows
@ingroup group_class
The following are a variety of classes that are derived from wxWindow.
*/

View File

@@ -0,0 +1,17 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_net.h
// Purpose: Networking classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_net Networking
@ingroup group_class
wxWidgets provides its own classes for socket based networking.
*/

View File

@@ -0,0 +1,18 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_pickers.h
// Purpose: Picker Control classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_pickers Picker Controls
@ingroup group_class
A picker control is a control whose appearance and behaviour is highly
platform-dependent.
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_printing.h
// Purpose: Printing Framework classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_printing Printing Framework
@ingroup group_class
A printing and previewing framework is implemented to make it relatively
straightforward to provide document printing facilities.
Related Overviews: @ref overview_printing
*/

View File

@@ -0,0 +1,18 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_richtext.h
// Purpose: Rich Text classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_richtext Rich Text
@ingroup group_class
wxWidgets provides a set of generic classes to edit and print simple rich text
with character and paragraph formatting.
*/

View File

@@ -0,0 +1,22 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_rtti.h
// Purpose: Runtime Type Information (RTTI) classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_rtti Runtime Type Information (RTTI)
@ingroup group_class
wxWidgets supports runtime manipulation of class information, and dynamic
creation of objects given class names.
Related Overviews: @ref overview_rtti
See also: @ref group_funcmacro_rtti "RTTI Functions and Macros"
*/

View File

@@ -0,0 +1,17 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_smartpointers.h
// Purpose: Smart Pointer classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_smartpointers Smart Pointers
@ingroup group_class
wxWidgets provides a few smart pointer class templates.
*/

View File

@@ -0,0 +1,19 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_stc.h
// Purpose: Scintilla Text Editor classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_stc Scintilla Text Editor
@ingroup group_class
wxWidgets also provides a wrapper around the Scintilla text editor control,
which is a control for plain-text editing with support for highlighting, smart
indentation, etc.
*/

View File

@@ -0,0 +1,18 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_streams.h
// Purpose: Stream classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_streams Streams
@ingroup group_class
wxWidgets has its own set of stream classes, as an alternative to often buggy
standard stream libraries, and to provide enhanced functionality.
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_threading.h
// Purpose: Threading classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_threading Threading
@ingroup group_class
wxWidgets provides a set of classes to make use of the native thread
capabilities of the various platforms.
Related Overviews: @ref overview_thread
*/

View File

@@ -0,0 +1,19 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_validator.h
// Purpose: Validator classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_validator Validators
@ingroup group_class
These are the window validators, used for filtering and validating user input.
Related Overviews: @ref overview_validator
*/

View File

@@ -0,0 +1,18 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_vfs.h
// Purpose: Virtual File System classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_vfs Virtual File System
@ingroup group_class
wxWidgets provides a set of classes that implement an extensible virtual file
system, used internally by the HTML classes.
*/

View File

@@ -0,0 +1,23 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_winlayout.h
// Purpose: Window Layout classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_winlayout Window Layout
@ingroup group_class
There are two different systems for laying out windows (and dialogs in
particular). One is based upon so-called sizers and it requires less typing,
thinking and calculating and will in almost all cases produce dialogs looking
equally well on all platforms, the other is based on so-called constraints and
is deprecated, though still available.
Related Overviews: @ref overview_sizer, @ref overview_constraints
*/

View File

@@ -0,0 +1,15 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_xml.h
// Purpose: XML classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_xml XML
@ingroup group_class
*/

View File

@@ -0,0 +1,20 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_xrc.h
// Purpose: XML Based Resource System (XRC) classes group docs
// Author: wxWidgets team
// RCS-ID: $Id: class_dc.h 52454 2008-03-12 19:08:48Z BP $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_xrc XML Based Resource System (XRC)
@ingroup group_class
Resources allow your application to create controls and other user interface
elements from specifications stored in an XML format.
Related Overviews: @ref overview_xrc
*/