Don't document private event handlers in doc/view frame classes.

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

diff --git a/docs/doxygen/mainpages/libs.h b/docs/doxygen/mainpages/libs.h
index 396c7c234a66522529ca772364c63404b73a1bcc..897debd50113cb6a7be3529c1fc9fc61bc57e523 100644 (file)
--- a/docs/doxygen/mainpages/libs.h
+++ b/docs/doxygen/mainpages/libs.h
@@ -3,154 +3,212 @@
 // Purpose:     Libraries page of the Doxygen manual
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     Libraries page of the Doxygen manual
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+/**

 
 

-/*!
+@page page_libs Library List

 
 

- @page page_libraries Libraries list
+wxWidgets can be built either as a single large library (this is called a
+<em>monolithic build</em>) or as several smaller libraries
+(<em>multilib build</em>). Multilib build is the default.

 
 

- wxWidgets can be built either as a single large
- library (this is called the <em>monolithic build</em>) or as several smaller
- libraries (<em>multilib build</em>}). Multilib build is the default.
+wxWidgets library is divided into libraries briefly described below. This
+diagram shows the dependencies between them:

 
 

- wxWidgets library is divided into libraries briefly described below. This
- diagram show dependencies between them:
+@dot
+digraph Dependancies
+{
+    node [shape = ellipse, fontname = "Courier", fontsize = 10, style = filled];

 
 

- @image html libs.gif
+    wxBase     [URL = "\ref page_libs_wxbase"];

 
 

- Please note that arrows indicate the "depends from" relation and that
- all blue boxes depend from @ref wxbase library (i.e. they are non-GUI libraries),
- and all green boxes depend from @ref wxcore library (i.e. they are GUI libraries).
+    wxCore     [fillcolor = deepskyblue, URL = "\ref page_libs_wxcore"];
+    wxNet      [fillcolor = deepskyblue, URL = "\ref page_libs_wxnet"];
+    wxXML      [fillcolor = deepskyblue, URL = "\ref page_libs_wxxml"];

 
 

+    wxAdvanced [fillcolor = green, URL = "\ref page_libs_wxadv"];
+    wxAUI      [fillcolor = green, URL = "\ref page_libs_wxaui"];
+    wxGL       [fillcolor = green, URL = "\ref page_libs_wxgl"];
+    wxHTML     [fillcolor = green, URL = "\ref page_libs_wxhtml"];
+    wxMedia    [fillcolor = green, URL = "\ref page_libs_wxmedia"];
+    wxPropertyGrid [fillcolor = green, URL = "\ref page_libs_wxpropgrid"];
+    wxQA       [fillcolor = green, URL = "\ref page_libs_wxqa"];
+    wxRibbon   [fillcolor = green, URL = "\ref page_libs_wxribbon"];
+    wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
+    wxSTC      [fillcolor = green, URL = "\ref page_libs_wxstc"];
+    wxXRC      [fillcolor = green, URL = "\ref page_libs_wxxrc"];
+    wxWebView  [fillcolor = green, URL = "\ref page_libs_wxwebview"];

 
 

- <!--
-    IMPORTANT: the @sections below don't have the page_libraries_ prefix because
-               all API pages link to them and using that prefix all times would
-               make the 
- -->
+    wxCore -> wxBase;
+    wxNet -> wxBase;
+    wxXML -> wxBase;

 
 

+    wxAdvanced -> wxCore;
+    wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML;
+    wxGL -> wxCore;
+    wxHTML -> wxCore;
+    wxMedia -> wxCore;
+    wxPropertyGrid -> wxAdvanced;
+    wxQA -> wxCore; wxQA -> wxXML;
+    wxRibbon -> wxCore;
+    wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
+    wxSTC -> wxCore;
+    wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
+    wxWebView -> wxCore;
+}
+@enddot

 
 

- @section page_libraries_wxbase wxBase
+Please note that arrows indicate the "depends from" relation and that all blue
+libraries depend on the @ref page_libs_wxbase library (i.e. they are non-GUI
+libraries), and all green libraries depend on the @ref page_libs_wxcore library
+(i.e. they are GUI libraries).

 
 

- Every wxWidgets application must link against this library. It contains
- mandatory classes that any wxWidgets code depends on (e.g. wxString) and
- portability classes that abstract differences between platforms.
- @ref wxbase can be used to develop console mode applications, it does not require
- any GUI libraries or running X Window System on Unix.

 
 

+@section page_libs_wxbase wxBase

 
 

- @section page_libraries_wxcore wxCore
+Every wxWidgets application must link against this library. It contains
+mandatory classes that any wxWidgets code depends on (e.g. wxString) and
+portability classes that abstract differences between platforms. wxBase can be
+used to develop console mode applications, it does not require any GUI
+libraries or running X Window System on Unix.

 
 

- Basic GUI classes such as GDI classes or controls are in this library. All
- wxWidgets GUI applications must link against this library, only console mode
- applications don't.

 
 

- Requires @ref wxbase.
+@section page_libs_wxcore wxCore

 
 

+Basic GUI classes such as GDI classes or controls are in this library. All
+wxWidgets GUI applications must link against this library, only console mode
+applications don't.

 
 

- @section wxaui wxAui
+Requires @ref page_libs_wxbase.

 
 

- This contains the Advanced User Interface docking library.

 
 

- Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
+@section page_libs_wxaui wxAui

 
 

+This contains the Advanced User Interface docking library.

 
 

- @section wxnet wxNet
+Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
+@ref page_libs_wxcore, @ref page_libs_wxbase.

 
 

- Classes for network access:

 
 

- @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
- @li wxSocketOutputStream and wxSocketInputStream
- @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
- @li wxURL
- @li wxInternetFSHandler (a wxFileSystem handler)
+@section page_libs_wxnet wxNet

 
 

- Requires @ref wxbase.
+Classes for network access:

 
 

+@li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
+@li wxSocketOutputStream and wxSocketInputStream
+@li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
+@li wxURL
+@li wxInternetFSHandler (a wxFileSystem handler)

 
 

- @section wxrichtext wxRichText
+Requires @ref page_libs_wxbase.

 
 

- This contains generic rich text control functionality.

 
 

- Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
+@section page_libs_wxpropgrid wxPropertyGrid

 
 

+This contains the wxPropertyGrid control.

 
 

- @section wxxml wxXML
+Requires @ref page_libs_wxadv, @ref page_libs_wxcore, @ref page_libs_wxbase.

 
 

- This library contains simple classes for parsing XML documents.

 
 

- Requires @ref wxbase.
+@section page_libs_wxribbon wxRibbon

 
 

+This contains the Ribbon User Interface components library.

 
 

- @section wxadv wxAdvanced
+Requires @ref page_libs_wxcore, @ref page_libs_wxbase.

 
 

- Advanced or rarely used GUI classes:

 
 

- @li wxCalendarCtrl
- @li wxGrid classes
- @li wxJoystick
- @li wxLayoutAlgorithm
- @li wxSplashScreen
- @li wxTaskBarIcon
- @li wxSound
- @li wxWizard
- @li wxSashLayoutWindow
- @li wxSashWindow
- @li ...others
+@section page_libs_wxrichtext wxRichText

 
 

- Requires @ref wxcore and @ref wxbase.
+This contains generic rich text control functionality.

 
 

+Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
+@ref page_libs_wxcore, @ref page_libs_wxbase.

 
 

- @section wxmedia wxMedia

 
 

- Miscellaneous classes related to multimedia. Currently this library only
- contains wxMediaCtrl but more classes will be added in
- the future.
+@section page_libs_wxxml wxXML

 
 

- Requires @ref wxcore and @ref wxbase.
+This library contains simple classes for parsing XML documents.

 
 

+Requires @ref page_libs_wxbase.

 
 

- @section wxgl wxGL

 
 

- This library contains wxGLCanvas class for integrating
- OpenGL library with wxWidgets. Unlike all others, this library is {\em not}
- part of the monolithic library, it is always built as separate library.
+@section page_libs_wxadv wxAdvanced

 
 

- Requires @ref wxcore and @ref wxbase.
+Advanced or rarely used GUI classes:

 
 

+@li wxCalendarCtrl
+@li wxGrid classes
+@li wxJoystick
+@li wxLayoutAlgorithm
+@li wxSplashScreen
+@li wxTaskBarIcon
+@li wxSound
+@li wxWizard
+@li wxSashLayoutWindow
+@li wxSashWindow
+@li ...others

 
 

- @section wxhtml wxHTML
+Requires @ref page_libs_wxcore and @ref page_libs_wxbase.

 
 

- Simple HTML renderer and other @ref html_overview are contained in this library, 
- as well as wxHtmlHelpController, wxBestHelpController and wxHtmlListBox.

 
 

- Requires @ref wxcore and @ref wxbase.
+@section page_libs_wxmedia wxMedia

 
 

+Miscellaneous classes related to multimedia. Currently this library only
+contains wxMediaCtrl but more classes will be added in the future.

 
 

- @section wxqa wxQA
+Requires @ref page_libs_wxcore and @ref page_libs_wxbase.

 
 

- This is the library containing extra classes for quality assurance. Currently
- it only contains wxDebugReport and related classes,
- but more will be added to it in the future.

 
 

- Requires @ref wxxml, @ref wxcore, @ref wxbase.
+@section page_libs_wxgl wxGL

 
 

+This library contains wxGLCanvas class for integrating OpenGL library with
+wxWidgets. Unlike all others, this library is @b not part of the monolithic
+library, it is always built as separate library.

 
 

- @section wxxrc wxXRC
+Requires @ref page_libs_wxcore and @ref page_libs_wxbase.

 
 

- This library contains wxXmlResource class that
- provides access to XML resource files in XRC format.

 
 

- Requires @ref wxadv, @ref wxhtml, @ref wxxml, @ref wxcore, @ref wxbase.
+@section page_libs_wxhtml wxHTML

 
 

+Simple HTML renderer and other @ref overview_html are contained in this
+library, as well as wxHtmlHelpController, wxBestHelpController and
+wxHtmlListBox.

 
 

- @section wxstc wxSTC
+Requires @ref page_libs_wxcore and @ref page_libs_wxbase.

 
 

- STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting text editor.
- See http://www.scintilla.org for more info about Scintilla.

 
 

- Requires @ref wxcore, @ref wxbase.
+@section page_libs_wxqa wxQA
+
+This is the library containing extra classes for quality assurance. Currently
+it only contains wxDebugReport and related classes, but more will be added to
+it in the future.
+
+Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
+
+
+@section page_libs_wxxrc wxXRC
+
+This library contains wxXmlResource class that provides access to XML resource
+files in XRC format.
+
+Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
+@ref page_libs_wxcore, @ref page_libs_wxbase.
+
+
+@section page_libs_wxstc wxSTC
+
+STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting
+text editor. See <http://www.scintilla.org/> for more info about Scintilla.
+
+Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
+
+@section page_libs_wxwebview wxWebView
+
+The wxWebView library contains the wxWebView control and its associated classes.
+
+Requires @ref page_libs_wxcore, @ref page_libs_wxbase.

 
 */
 
 */

+