Updated library dependancy graph to use Graphviz (through Doxygen) while removing...

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52282 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/doxygen/images/libs.bmp b/docs/doxygen/images/libs.bmp
deleted file mode 100644 (file)
index fb0f9e3..0000000
Binary files a/docs/doxygen/images/libs.bmp and /dev/null differ

diff --git a/docs/doxygen/images/libs.gif b/docs/doxygen/images/libs.gif
deleted file mode 100644 (file)
index 707f2ce..0000000
Binary files a/docs/doxygen/images/libs.gif and /dev/null differ

diff --git a/docs/doxygen/mainpages/libs.h b/docs/doxygen/mainpages/libs.h
index f944d7700e27f90d2400eef8d0c441d65b3bb35a..e0ead95a562c1232e7f4aedceb32d8b63abf0c77 100644 (file)
--- a/docs/doxygen/mainpages/libs.h
+++ b/docs/doxygen/mainpages/libs.h
@@ -6,154 +6,183 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-

 /*!
 
 /*!
 

- @page page_libs Libraries list
+@page page_libs Library 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 library is divided into libraries briefly described below. This
+diagram show dependencies between them:

 
 

- 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.
+@dot
+digraph Dependancies
+{
+    node [shape = ellipse, fontname = "Courier", fontsize = 10, style = filled];

 
 

- wxWidgets library is divided into libraries briefly described below. This
- diagram show dependencies between them:
+    wxBase     [URL = "\ref page_libs_wxbase"];

 
 

- @image html libs.gif
+    wxCore     [fillcolor = deepskyblue, URL = "\ref page_libs_wxcore"];
+    wxNet      [fillcolor = deepskyblue, URL = "\ref page_libs_wxNet"];
+    wxXML      [fillcolor = deepskyblue, URL = "\ref page_libs_wxxml"];

 
 

- Please note that arrows indicate the "depends from" relation and that
- all blue boxes depend from @ref page_libs_wxbase library (i.e. they are non-GUI libraries),
- and all green boxes depend from @ref page_libs_wxcore library (i.e. they are GUI libraries).
+    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"];
+    wxQA       [fillcolor = green, URL = "\ref page_libs_wxqa"];
+    wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
+    wxSTC      [fillcolor = green, URL = "\ref page_libs_wxstc"];
+    wxXRC      [fillcolor = green, URL = "\ref page_libs_wxxrc"];

 
 

+    wxCore -> wxBase;
+    wxNet -> wxBase;
+    wxXML -> wxBase;

 
 

- <!--
-    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 
- -->
+    wxAdvanced -> wxCore;
+    wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML;
+    wxGL -> wxCore;
+    wxHTML -> wxCore;
+    wxMedia -> wxCore;
+    wxQA -> wxCore; wxQA -> wxXML;
+    wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
+    wxSTC -> wxCore;
+    wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
+}
+@enddot

 
 

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

 
 

- @section page_libs_wxbase wxBase

 
 

- 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.
+@section page_libs_wxbase wxBase

 
 

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

 
 

- @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 page_libs_wxcore wxCore

 
 

- Requires @ref page_libs_wxbase.
+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 page_libs_wxbase.

 
 

- @section page_libs_wxaui wxAui

 
 

- This contains the Advanced User Interface docking library.
+@section page_libs_wxaui wxAui

 
 

- Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, 
- @ref page_libs_wxcore, @ref page_libs_wxbase.
+This contains the Advanced User Interface docking library.

 
 

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

 
 

- @section page_libs_wxnet wxNet

 
 

- Classes for network access:
+@section page_libs_wxnet wxNet

 
 

- @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)
+Classes for network access:

 
 

- Requires @ref page_libs_wxbase.
+@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)

 
 

+Requires @ref page_libs_wxbase.

 
 

- @section page_libs_wxrichtext wxRichText

 
 

- This contains generic rich text control functionality.
+@section page_libs_wxrichtext wxRichText

 
 

- Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, 
- @ref page_libs_wxcore, @ref page_libs_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 page_libs_wxxml wxXML

 
 

- This library contains simple classes for parsing XML documents.
+@section page_libs_wxxml wxXML

 
 

- Requires @ref page_libs_wxbase.
+This library contains simple classes for parsing XML documents.

 
 

+Requires @ref page_libs_wxbase.

 
 

- @section page_libs_wxadv wxAdvanced

 
 

- Advanced or rarely used GUI classes:
+@section page_libs_wxadv wxAdvanced

 
 

- @li wxCalendarCtrl
- @li wxGrid classes
- @li wxJoystick
- @li wxLayoutAlgorithm
- @li wxSplashScreen
- @li wxTaskBarIcon
- @li wxSound
- @li wxWizard
- @li wxSashLayoutWindow
- @li wxSashWindow
- @li ...others
+Advanced or rarely used GUI classes:

 
 

- Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
+@li wxCalendarCtrl
+@li wxGrid classes
+@li wxJoystick
+@li wxLayoutAlgorithm
+@li wxSplashScreen
+@li wxTaskBarIcon
+@li wxSound
+@li wxWizard
+@li wxSashLayoutWindow
+@li wxSashWindow
+@li ...others

 
 

+Requires @ref page_libs_wxcore and @ref page_libs_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 page_libs_wxmedia wxMedia

 
 

- Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
+Miscellaneous classes related to multimedia. Currently this library only
+contains wxMediaCtrl but more classes will be added in the future.

 
 

+Requires @ref page_libs_wxcore and @ref page_libs_wxbase.

 
 

- @section page_libs_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_wxgl wxGL

 
 

- Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
+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.

 
 

+Requires @ref page_libs_wxcore and @ref page_libs_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 page_libs_wxhtml wxHTML

 
 

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

 
 

+Requires @ref page_libs_wxcore and @ref page_libs_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.
+@section page_libs_wxqa wxQA

 
 

- Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @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 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.
+@section page_libs_wxxrc wxXRC

 
 

- Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, 
- @ref page_libs_wxcore, @ref page_libs_wxbase.
+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.
+@section page_libs_wxstc wxSTC

 
 

- Requires @ref page_libs_wxcore, @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 page_libs_wxcore, @ref page_libs_wxbase.

 
 */
 
 */

+