recategorize many misplaced classes; move lots of classes from miscellaneous [window] category to more specific categories; add the 'Book controls' and the 'Application and system configuration' class groups

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

docs/doxygen/Doxyfile_inc

@@ -92,6 +92,7 @@ ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance
 # aliases for additional wx-specific infos
 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
+ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
 ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
 ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"

docs/doxygen/groups/class_appmanagement.h

@@ -11,8 +11,9 @@
 @defgroup group_class_appmanagement Application and Process Management
 @ingroup group_class
 
-The classes in this section are used to handle application-wide settings or
+The classes in this section represent the application (see wxApp) or parts of it
-for initialization/shutdown of the application itself.
+(e.g. wxEventLoopBase, wxModule).
+They can be used for initialization/shutdown of the application itself.
 
 Related macros/global-functions group: @ref group_funcmacro_appinitterm.
 

docs/doxygen/groups/class_bookctrl.h

@@ -0,0 +1,19 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        class_bookctrl.h
+// Purpose:     Book controls classes group docs
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@defgroup group_class_bookctrl Book Controls
+@ingroup group_class
+
+A book control contains pages of other controls.
+
+Related overview: @ref overview_bookctrl
+
+*/
+

docs/doxygen/groups/class_cfg.h

@@ -0,0 +1,18 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        class_cfg.h
+// Purpose:     Application and System configuration classes group docs
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@defgroup group_class_cfg Application and System configuration
+@ingroup group_class
+
+The classes in this section are used to handle application-wide settings
+and system-wide settings.
+
+*/
+

docs/doxygen/groups/class_data.h

@@ -12,6 +12,9 @@
 @ingroup group_class
 
 These are the data structure classes provided by wxWidgets.
+Some of them are used to store generic data (e.g. wxPoint, wxSize, etc),
+others are mainly helpers of other classes (e.g. wxListItem, wxCalendarDateAttr,
+wxFindReplaceDialogData, etc).
 
 */
 

interface/wx/aboutdlg.h

@@ -31,7 +31,7 @@
     so you should avoid specifying these fields to achieve more native look and feel.
 
     @library{wxadv}
-    @category{misc}
+    @category{cmndlg,data}
 
     @see wxAboutDialogInfo::SetArtists
 */

interface/wx/accel.h

@@ -34,7 +34,7 @@ enum wxAcceleratorEntryFlags
     (see wxAcceleratorTable).
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @see wxAcceleratorTable, wxWindow::SetAcceleratorTable
 */
@@ -157,7 +157,7 @@ public:
     'OK'.
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @stdobjects
     ::wxNullAcceleratorTable

interface/wx/apptrait.h

@@ -23,7 +23,7 @@
     implementation of the wxAppTraits interface.
 
     @library{wxbase}
-    @category{appmanagement}
+    @category{cfg}
 
     @see @ref overview_app, wxApp
 */

interface/wx/artprov.h

@@ -164,7 +164,7 @@ typedef wxString wxArtID;
     identical bitmap for different client values!
 
     @library{wxcore}
-    @category{misc,data}
+    @category{misc}
 
     @see the @ref page_samples_artprov for an example of wxArtProvider usage.
 */

interface/wx/bitmap.h

@@ -29,7 +29,7 @@
     wxBitmap class documentation.
 
     @library{wxcore}
-    @category{misc}
+    @category{gdi}
 
     @see @ref overview_bitmap, wxBitmap, wxIcon, wxCursor
 */

interface/wx/bookctrl.h

@@ -23,7 +23,7 @@
     This is a pure virtual class so you cannot allocate it directly.
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
 
     @see @ref overview_bookctrl
 */
@@ -363,7 +363,7 @@ public:
     probably unnecessary to process both events at once.
 
     @library{wxcore}
-    @category{events}
+    @category{events,bookctrl}
 
     @see wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
 */

interface/wx/buffer.h

@@ -12,8 +12,11 @@
 
     @todo provide better docs for this class
 
+    @tparam T
+        The type of the characters stored in this class.
+
     @nolibrary
-    @category{misc}
+    @category{data}
 */
 template <typename T>
 class wxCharTypeBuffer
@@ -45,7 +48,7 @@ public:
     @todo provide better docs for this class
 
     @nolibrary
-    @category{misc}
+    @category{data}
 */
 class wxCharBuffer : public wxCharTypeBuffer<char>
 {
@@ -63,7 +66,7 @@ public:
     This class is available only when <tt>wxUSE_WCHAR_T==1</tt>
 
     @nolibrary
-    @category{misc}
+    @category{data}
 */
 class wxWCharBuffer : public wxCharTypeBuffer<wchar_t>
 {
@@ -76,8 +79,6 @@ public:
     wxWCharBuffer(const wxCStrData& cstr);
 };
 
-
-
 /**
     @class wxMemoryBuffer
 

interface/wx/calctrl.h

@@ -53,7 +53,7 @@ enum wxCalendarDateBorder
     of this class are used with wxCalendarCtrl.
 
     @library{wxadv}
-    @category{misc}
+    @category{data}
 
     @see wxCalendarCtrl
 */

interface/wx/choicebk.h

@@ -46,7 +46,7 @@
     @endEventTable
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
     @appearance{choicebook.png}
 
     @see @ref overview_bookctrl, wxNotebook, @ref page_samples_notebook

interface/wx/cmndata.h

@@ -12,7 +12,7 @@
     This class holds a variety of information related to font dialogs.
 
     @library{wxcore}
-    @category{cmndlg}
+    @category{cmndlg,data}
 
     @see @ref overview_cmndlg_font, wxFont, wxFontDialog
 */
@@ -137,7 +137,7 @@ public:
     stored by wxPageSetupDialogData).
 
     @library{wxcore}
-    @category{printing}
+    @category{printing,data}
 
     @see @ref overview_printing, wxPageSetupDialog
 */
@@ -349,7 +349,7 @@ public:
     This class holds a variety of information related to colour dialogs.
 
     @library{wxcore}
-    @category{cmndlg}
+    @category{cmndlg,data}
 
     @see wxColour, wxColourDialog, @ref overview_cmndlg_colour
 */
@@ -511,7 +511,7 @@ enum wxPrintBin
     @endcode
 
     @library{wxcore}
-    @category{printing}
+    @category{printing,data}
 
     @see @ref overview_printing, wxPrintDialog, wxPageSetupDialog,
          wxPrintDialogData, wxPageSetupDialogData, @ref overview_cmndlg_print,
@@ -681,7 +681,7 @@ public:
     settings.
 
     @library{wxcore}
-    @category{printing}
+    @category{printing,cmndlg,data}
 
     @see @ref overview_printing, wxPrintDialog, @ref overview_cmndlg_print
 */

interface/wx/config.h

@@ -255,7 +255,7 @@
 
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 */
 class wxConfigBase : public wxObject
 {

interface/wx/datetime.h

@@ -2045,7 +2045,7 @@ public:
     @todo Write wxDateTimeHolidayAuthority documentation.
 
     @library{wxbase}
-    @category{misc}
+    @category{data}
 */
 class wxDateTimeHolidayAuthority
 {

interface/wx/display.h

@@ -12,7 +12,7 @@
     Determines the sizes and locations of displays connected to the system.
 
     @library{wxcore}
-    @category{misc}
+    @category{cfg}
 
     @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
 */

interface/wx/encconv.h

@@ -18,14 +18,13 @@
     @c wxFONTENCODING_KOI8.
 
     @note
-
     Please use wxMBConv classes instead if possible. wxCSConv has much better
     support for various encodings than wxEncodingConverter.
     wxEncodingConverter is useful only if you rely on wxCONVERT_SUBSTITUTE mode
     of operation (see wxEncodingConverter::Init()).
 
     @library{wxbase}
-    @category{misc}
+    @category{conv}
 
     @see wxFontMapper, wxMBConv, @ref overview_nonenglish
 */

interface/wx/event.h

@@ -2562,7 +2562,7 @@ public:
     (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
 
     @library{wxcore}
-    @category{events}
+    @category{events,threading}
 
     @see @ref overview_thread, wxEventLoopBase::YieldFor
 */

interface/wx/fdrepdlg.h

@@ -111,7 +111,7 @@ public:
     dialog and calling them has no effect later.
 
     @library{wxcore}
-    @category{data}
+    @category{cmndlg,data}
 */
 class wxFindReplaceData : public wxObject
 {

interface/wx/fileconf.h

@@ -20,7 +20,7 @@
     Windows.
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see wxFileConfig::Save
 */

interface/wx/filectrl.h

@@ -40,14 +40,14 @@
     @endEventTable
 
     @library{wxbase}
-    @category{miscwnd}
+    @category{ctrl}
     @appearance{filectrl.png}
 
     @nativeimpl{wxgtk}
 
     @see wxGenericDirCtrl
 */
-class wxFileCtrl : public wxWindow
+class wxFileCtrl : public wxControl
 {
 public:
     wxFileCtrl();

interface/wx/fontmap.h

@@ -54,9 +54,9 @@
     @endcode
 
     @library{wxcore}
-    @category{misc}
+    @category{cfg}
 
-    @see wxEncodingConverter, @ref overview_nonenglish "Writing non-English applications"
+    @see wxEncodingConverter, @ref overview_nonenglish
 */
 class wxFontMapper
 {

interface/wx/headerctrl.h

@@ -645,7 +645,7 @@ protected:
     Event class representing the events generated by wxHeaderCtrl.
 
     @library{wxcore}
-    @category{ctrl}
+    @category{events}
 
     @see wxHeaderCtrl
 */

interface/wx/image.h

@@ -63,7 +63,7 @@ enum wxImagePNGType
     ::wxNullImage
 
     @library{wxcore}
-    @category{misc}
+    @category{gdi}
 
     @see wxImage, wxInitAllImageHandlers()
 */
@@ -526,7 +526,7 @@ public:
         If the image has an alpha channel, all pixels with alpha value less
         than @a threshold are replaced with the mask colour and the alpha
         channel is removed. Otherwise nothing is done.
-        
+
         The mask colour is chosen automatically using
         FindFirstUnusedColour() by this function, see the overload below if you
         this is not appropriate.
@@ -558,7 +558,7 @@ public:
             considered to be opaque.
 
      */
-    void ConvertAlphaToMask(unsigned char mr, unsigned char mg, unsigned char mb, 
+    void ConvertAlphaToMask(unsigned char mr, unsigned char mg, unsigned char mb,
                             unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD);
     //@}
 

interface/wx/intl.h

@@ -361,7 +361,7 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo
     @endWxPerlOnly
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see @ref overview_i18n, @ref page_samples_internat, wxXLocale
 */

interface/wx/list.h

@@ -89,7 +89,7 @@
         The type stored in the wxList nodes.
 
     @library{wxbase}
-    @category{data}
+    @category{containers}
 
     @see wxArray<T>, wxVector<T>, wxNode<T>
 */

interface/wx/listbook.h

@@ -45,7 +45,7 @@
     @endEventTable
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
     @appearance{listbook.png}
 
     @see wxBookCtrl, wxNotebook, @ref page_samples_notebook

interface/wx/listctrl.h

@@ -1084,7 +1084,7 @@ public:
     Represents the attributes (color, font, ...) of a wxListCtrl's wxListItem.
 
     @library{wxbase}
-    @category{ctrl}
+    @category{data}
 
     @see @ref overview_listctrl, wxListCtrl, wxListItem
 */
@@ -1296,7 +1296,7 @@ enum wxListColumnFormat
     If the colour/font is not specified, the default list control colour/font is used.
 
     @library{wxbase}
-    @category{ctrl}
+    @category{data}
 
     @see wxListCtrl
 */

interface/wx/metafile.h

@@ -69,7 +69,7 @@ public:
     @onlyfor{wxmsw}
 
     @library{wxcore}
-    @category{gdi,misc}
+    @category{gdi}
 
     @see wxMetafileDC
 */

interface/wx/mimetype.h

@@ -68,7 +68,7 @@
 
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see wxFileType
 */
@@ -228,7 +228,7 @@ wxMimeTypesManager* wxTheMimeTypesManager;
 
 
     @library{wxbase}
-    @category{misc}
+    @category{data}
 
     @see wxMimeTypesManager
 */

interface/wx/module.h

@@ -73,7 +73,7 @@
     @endcode
 
     @library{wxbase}
-    @category{misc}
+    @category{appmanagement}
 */
 class wxModule : public wxObject
 {

interface/wx/msgqueue.h

@@ -7,23 +7,25 @@
 /////////////////////////////////////////////////////////////////////////////
 
 /**
-
     wxMessageQueue allows passing messages between threads.
 
     This class should be typically used to communicate between the main and worker
     threads. The main thread calls wxMessageQueue::Post and the worker thread
     calls wxMessageQueue::Receive.
 
-    For this class a message is an object of arbitrary type T.
+    @tparam T
+        For this class a message is an object of arbitrary type T.
+
     Notice that often there is a some special message indicating that the thread
     should terminate as there is no other way to gracefully shutdown a thread
     waiting on the message queue.
 
     @nolibrary
-    @category{misc}
+    @category{threading}
 
     @see wxThread
 */
+template <typename T>
 class wxMessageQueue<T>
 {
 public:

interface/wx/msw/ole/activex.h

@@ -279,7 +279,7 @@ public:
     @onlyfor{wxmsw}
 
     @library{wxbase}
-    @category{misc,ipc}
+    @category{ctrl,ipc}
 
     @see wxActiveXEvent, @ref page_samples_flash
 */

interface/wx/msw/ole/automtn.h

@@ -33,7 +33,7 @@
     @onlyfor{wxmsw}
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @see wxVariant
 */

interface/wx/msw/registry.h

@@ -32,9 +32,6 @@
 
     @onlyfor{wxmsw}
 
-    @library{wxbase}
-    @category{misc}
-
     @b Example:
 
     @code
@@ -64,6 +61,10 @@
         key->GetNextKey(key_name, 1);
     }
     @endcode
+
+
+    @library{wxbase}
+    @category{cfg}
 */
 class wxRegKey
 {
@@ -77,7 +78,7 @@ public:
     */
     wxRegKey(const wxString& strKey);
     /**
-        The constructor to set the full name of the key using one of the 
+        The constructor to set the full name of the key using one of the
         standard keys, that is, HKCR, HKCU, HKLM, HKUSR, HKPD, HKCC or HKDD.
     */
     wxRegKey(StdKey keyParent, const wxString& strKey);
@@ -96,7 +97,7 @@ public:
         Write ///< Read and Write
     };
 
-    /** 
+    /**
         The standard registry key enumerator.
     */
     enum StdKey
@@ -128,7 +129,7 @@ public:
     Type_Multi_String,        ///< Multiple Unicode strings
     Type_Resource_list,       ///< Resource list in the resource map
     Type_Full_resource_descriptor,  ///< Resource list in the hardware description
-    Type_Resource_requirements_list ///< 
+    Type_Resource_requirements_list ///<
     };
 
     /**
@@ -146,12 +147,12 @@ public:
         using the key. Returns @true if successful.
     */
     bool Copy(wxRegKey& keyDst);
-    
+
     /**
         Copy the value to another key, possibly changing its name. By default
         it will remain the same. Returns @true if successful.
     */
-    bool CopyValue(const wxString& szValue, wxRegKey& keyDst,    
+    bool CopyValue(const wxString& szValue, wxRegKey& keyDst,
                   const wxString& szNewName = wxEmptyString);
     /**
         Creates the key. Will fail if the key already exists and @a bOkIfExists
@@ -170,7 +171,7 @@ public:
     void DeleteSelf();
 
     /**
-        Deletes the named value or use an empty string argument to remove the 
+        Deletes the named value or use an empty string argument to remove the
         default value of the key.
     */
     void DeleteValue(const wxString& szKey);
@@ -192,7 +193,7 @@ public:
         Returns @true if successful.
     */
     bool Export(wxOutputStream& ostr) const;
-    
+
     /**
         Gets the first key. Returns @true if successful.
     */
@@ -237,7 +238,7 @@ public:
         Gets the value type.
     */
     ValueType GetValueType(const wxString& szValue) const;
-    
+
     /**
         Returns @true if given subkey exists.
     */
@@ -324,13 +325,13 @@ public:
     /**
         Preallocate some memory for the name. For wxRegConfig usage only.
     */
-    void ReserveMemoryForName(size_t bytes); 
+    void ReserveMemoryForName(size_t bytes);
 
     /**
         Set or change the HKEY handle.
     */
     void SetHkey(WXHKEY hKey);
-    
+
     /**
         Set the full key name. The name is absolute. It should start with
         HKEY_xxx.
@@ -344,7 +345,7 @@ public:
         Set the name relative to the parent key
     */
     void SetName(const wxRegKey& keyParent, const wxString& strKey);
-    
+
     /**
         Sets the given @a szValue which must be numeric. If the value doesn't
         exist, it is created. Returns @true if successful.
@@ -356,7 +357,7 @@ public:
     */
     bool SetValue(const wxString& szValue, const wxString& strValue);
     /**
-        Sets the given @a szValue which must be binary. If the value doesn't 
+        Sets the given @a szValue which must be binary. If the value doesn't
         exist, it is created. Returns @true if successful.
     */
     bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);

interface/wx/notebook.h

@@ -85,7 +85,7 @@
 
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
     @appearance{notebook.png}
 
     @see wxBookCtrl, wxBookCtrlEvent, wxImageList, @ref page_samples_notebook

interface/wx/platinfo.h

@@ -116,7 +116,7 @@ enum wxEndianness
     where it's running.
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see ::wxGetOsVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(),
          wxAppTraits

interface/wx/settings.h

@@ -163,7 +163,7 @@ enum wxSystemScreenType
     and user interface element sizes.
 
     @library{wxcore}
-    @category{misc}
+    @category{cfg}
 
     @see wxFont, wxColour
 */

interface/wx/snglinst.h

@@ -57,7 +57,7 @@
     system call, but almost all of modern Unix systems do) only.
 
     @library{wxbase}
-    @category{misc}
+    @category{appmanagement}
 */
 class wxSingleInstanceChecker
 {

interface/wx/sound.h

@@ -16,7 +16,7 @@
     Open Sound System or Simple DirectMedia Layer).
 
     @library{wxadv}
-    @category{misc}
+    @category{media}
 */
 class wxSound : public wxObject
 {

interface/wx/stc/stc.h

@@ -14,7 +14,7 @@
     @todo list styled text ctrl events.
 
     @library{wxbase}
-    @category{events}
+    @category{events,stc}
 */
 class wxStyledTextEvent : public wxCommandEvent
 {

interface/wx/sysopt.h

@@ -122,7 +122,7 @@
     The compile-time option to include or exclude this functionality is wxUSE_SYSTEM_OPTIONS.
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see wxSystemSettings
 */

interface/wx/toolbook.h

@@ -41,7 +41,7 @@
     @endEventTable
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
 
     @see @ref overview_bookctrl, wxBookCtrlBase, wxNotebook,
          @ref page_samples_notebook

interface/wx/treebase.h

@@ -12,7 +12,7 @@
     An opaque reference to a tree item.
 
     @library{wxcore}
-    @category{misc}
+    @category{data}
 
     @see wxTreeCtrl, wxTreeItemData, @ref overview_treectrl
 */

interface/wx/treebook.h

@@ -38,7 +38,7 @@
     @endEventTable
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
 
     @see wxBookCtrl, wxBookCtrlEvent, wxNotebook, wxTreeCtrl, wxImageList,
          @ref overview_bookctrl, @ref page_samples_notebook

interface/wx/vidmode.h

@@ -12,7 +12,7 @@
     Determines the sizes and locations of displays connected to the system.
 
     @library{wxcore}
-    @category{misc}
+    @category{cfg}
 
     @stdobjects
     ::wxDefaultVideoMode

interface/wx/windowid.h

@@ -19,7 +19,7 @@ typedef int wxWindowID;
     and can also be used be used directly.
 
     @library{wxcore}
-    @category{misc}
+    @category{cfg}
 
     @see wxWindow::NewControlId(), wxWindow::UnreserveControlId(),
          @ref overview_windowids

interface/wx/xlocale.h

@@ -61,7 +61,7 @@
     IO) in the near future.
 
     @library{wxbase}
-    @category{misc}
+    @category{cfg}
 
     @see wxLocale
 */