From 3c99e2fd1b3432974b892be508c0757da5b6ad49 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Fri, 20 Feb 2009 11:34:52 +0000 Subject: [PATCH] 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 | 1 + docs/doxygen/groups/class_appmanagement.h | 5 ++-- docs/doxygen/groups/class_bookctrl.h | 19 ++++++++++++++ docs/doxygen/groups/class_cfg.h | 18 +++++++++++++ docs/doxygen/groups/class_data.h | 3 +++ interface/wx/aboutdlg.h | 2 +- interface/wx/accel.h | 4 +-- interface/wx/apptrait.h | 2 +- interface/wx/artprov.h | 2 +- interface/wx/bitmap.h | 2 +- interface/wx/bookctrl.h | 4 +-- interface/wx/buffer.h | 11 ++++---- interface/wx/calctrl.h | 2 +- interface/wx/choicebk.h | 2 +- interface/wx/cmndata.h | 10 ++++---- interface/wx/config.h | 2 +- interface/wx/datetime.h | 2 +- interface/wx/display.h | 2 +- interface/wx/encconv.h | 3 +-- interface/wx/event.h | 2 +- interface/wx/fdrepdlg.h | 2 +- interface/wx/fileconf.h | 2 +- interface/wx/filectrl.h | 4 +-- interface/wx/fontmap.h | 4 +-- interface/wx/headerctrl.h | 2 +- interface/wx/image.h | 6 ++--- interface/wx/intl.h | 2 +- interface/wx/list.h | 2 +- interface/wx/listbook.h | 2 +- interface/wx/listctrl.h | 4 +-- interface/wx/metafile.h | 2 +- interface/wx/mimetype.h | 4 +-- interface/wx/module.h | 2 +- interface/wx/msgqueue.h | 8 +++--- interface/wx/msw/ole/activex.h | 2 +- interface/wx/msw/ole/automtn.h | 2 +- interface/wx/msw/registry.h | 31 ++++++++++++----------- interface/wx/notebook.h | 2 +- interface/wx/platinfo.h | 2 +- interface/wx/settings.h | 2 +- interface/wx/snglinst.h | 2 +- interface/wx/sound.h | 2 +- interface/wx/stc/stc.h | 2 +- interface/wx/sysopt.h | 2 +- interface/wx/toolbook.h | 2 +- interface/wx/treebase.h | 2 +- interface/wx/treebook.h | 2 +- interface/wx/vidmode.h | 2 +- interface/wx/windowid.h | 2 +- interface/wx/xlocale.h | 2 +- 50 files changed, 125 insertions(+), 80 deletions(-) create mode 100644 docs/doxygen/groups/class_bookctrl.h create mode 100644 docs/doxygen/groups/class_cfg.h diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 2a695611ef..6735ab7b00 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -92,6 +92,7 @@ ALIASES += appearance{1}="\htmlonly
Appearance # aliases for additional wx-specific infos ALIASES += category{1}="\ingroup group_class_\1 \n
Category:  \ref group_class_\1
" ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n
Category:  \ref group_class_\1, \ref group_class_\2
" +ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n
Category:  \ref group_class_\1, \ref group_class_\2, \ref group_class_\3
" ALIASES += library{1}="

Library:  \ref page_libs_\1
" ALIASES += nolibrary="

Library:  None; this class implementation is entirely header-based.
" ALIASES += stdobjects="Predefined objects/pointers:" diff --git a/docs/doxygen/groups/class_appmanagement.h b/docs/doxygen/groups/class_appmanagement.h index 95f805f237..211f348ae1 100644 --- a/docs/doxygen/groups/class_appmanagement.h +++ b/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 -for initialization/shutdown of the application itself. +The classes in this section represent the application (see wxApp) or parts of it +(e.g. wxEventLoopBase, wxModule). +They can be used for initialization/shutdown of the application itself. Related macros/global-functions group: @ref group_funcmacro_appinitterm. diff --git a/docs/doxygen/groups/class_bookctrl.h b/docs/doxygen/groups/class_bookctrl.h new file mode 100644 index 0000000000..2b368085ca --- /dev/null +++ b/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 + +*/ + diff --git a/docs/doxygen/groups/class_cfg.h b/docs/doxygen/groups/class_cfg.h new file mode 100644 index 0000000000..68f13e577a --- /dev/null +++ b/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. + +*/ + diff --git a/docs/doxygen/groups/class_data.h b/docs/doxygen/groups/class_data.h index 15c71edb64..8150162c65 100644 --- a/docs/doxygen/groups/class_data.h +++ b/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). */ diff --git a/interface/wx/aboutdlg.h b/interface/wx/aboutdlg.h index 7d98bab25c..7342a3ed0a 100644 --- a/interface/wx/aboutdlg.h +++ b/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 */ diff --git a/interface/wx/accel.h b/interface/wx/accel.h index e7d60861a5..bc67d5f3b2 100644 --- a/interface/wx/accel.h +++ b/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 diff --git a/interface/wx/apptrait.h b/interface/wx/apptrait.h index 6251c5623d..57c2b6d586 100644 --- a/interface/wx/apptrait.h +++ b/interface/wx/apptrait.h @@ -23,7 +23,7 @@ implementation of the wxAppTraits interface. @library{wxbase} - @category{appmanagement} + @category{cfg} @see @ref overview_app, wxApp */ diff --git a/interface/wx/artprov.h b/interface/wx/artprov.h index b8a0a742d3..b141297fb5 100644 --- a/interface/wx/artprov.h +++ b/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. */ diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h index b0a215917e..f9d7948ea7 100644 --- a/interface/wx/bitmap.h +++ b/interface/wx/bitmap.h @@ -29,7 +29,7 @@ wxBitmap class documentation. @library{wxcore} - @category{misc} + @category{gdi} @see @ref overview_bitmap, wxBitmap, wxIcon, wxCursor */ diff --git a/interface/wx/bookctrl.h b/interface/wx/bookctrl.h index 9a0d5936b2..4407e51c28 100644 --- a/interface/wx/bookctrl.h +++ b/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 */ diff --git a/interface/wx/buffer.h b/interface/wx/buffer.h index 504df2aeb6..d8766639b0 100644 --- a/interface/wx/buffer.h +++ b/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 class wxCharTypeBuffer @@ -45,7 +48,7 @@ public: @todo provide better docs for this class @nolibrary - @category{misc} + @category{data} */ class wxCharBuffer : public wxCharTypeBuffer { @@ -63,7 +66,7 @@ public: This class is available only when wxUSE_WCHAR_T==1 @nolibrary - @category{misc} + @category{data} */ class wxWCharBuffer : public wxCharTypeBuffer { @@ -76,8 +79,6 @@ public: wxWCharBuffer(const wxCStrData& cstr); }; - - /** @class wxMemoryBuffer diff --git a/interface/wx/calctrl.h b/interface/wx/calctrl.h index dc0c5c9bf4..536c5a3f11 100644 --- a/interface/wx/calctrl.h +++ b/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 */ diff --git a/interface/wx/choicebk.h b/interface/wx/choicebk.h index bc3fec7ea1..7ed79cd30c 100644 --- a/interface/wx/choicebk.h +++ b/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 diff --git a/interface/wx/cmndata.h b/interface/wx/cmndata.h index 4fd908859e..81c8a126b5 100644 --- a/interface/wx/cmndata.h +++ b/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 */ diff --git a/interface/wx/config.h b/interface/wx/config.h index cc134b0029..5afaeeff33 100644 --- a/interface/wx/config.h +++ b/interface/wx/config.h @@ -255,7 +255,7 @@ @library{wxbase} - @category{misc} + @category{cfg} */ class wxConfigBase : public wxObject { diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h index 9505c3d9a6..70cf1c5a89 100644 --- a/interface/wx/datetime.h +++ b/interface/wx/datetime.h @@ -2045,7 +2045,7 @@ public: @todo Write wxDateTimeHolidayAuthority documentation. @library{wxbase} - @category{misc} + @category{data} */ class wxDateTimeHolidayAuthority { diff --git a/interface/wx/display.h b/interface/wx/display.h index 20811d7580..421def972f 100644 --- a/interface/wx/display.h +++ b/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() */ diff --git a/interface/wx/encconv.h b/interface/wx/encconv.h index f7e477d80c..ceba036f84 100644 --- a/interface/wx/encconv.h +++ b/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 */ diff --git a/interface/wx/event.h b/interface/wx/event.h index 65b08c1678..021e0da342 100644 --- a/interface/wx/event.h +++ b/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 */ diff --git a/interface/wx/fdrepdlg.h b/interface/wx/fdrepdlg.h index e8a42a4123..a396bab8f8 100644 --- a/interface/wx/fdrepdlg.h +++ b/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 { diff --git a/interface/wx/fileconf.h b/interface/wx/fileconf.h index 641b3b5adf..df88c8e24a 100644 --- a/interface/wx/fileconf.h +++ b/interface/wx/fileconf.h @@ -20,7 +20,7 @@ Windows. @library{wxbase} - @category{misc} + @category{cfg} @see wxFileConfig::Save */ diff --git a/interface/wx/filectrl.h b/interface/wx/filectrl.h index e7ff427953..56be6351e8 100644 --- a/interface/wx/filectrl.h +++ b/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(); diff --git a/interface/wx/fontmap.h b/interface/wx/fontmap.h index f3bb9ebcd4..104a5ec81a 100644 --- a/interface/wx/fontmap.h +++ b/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 { diff --git a/interface/wx/headerctrl.h b/interface/wx/headerctrl.h index 862d26c5b6..73142a1959 100644 --- a/interface/wx/headerctrl.h +++ b/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 */ diff --git a/interface/wx/image.h b/interface/wx/image.h index a45715b2c4..a5e959b677 100644 --- a/interface/wx/image.h +++ b/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); //@} diff --git a/interface/wx/intl.h b/interface/wx/intl.h index 06ef0aa23c..6940db7779 100644 --- a/interface/wx/intl.h +++ b/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 */ diff --git a/interface/wx/list.h b/interface/wx/list.h index a770d433d6..bee1b9c1d0 100644 --- a/interface/wx/list.h +++ b/interface/wx/list.h @@ -89,7 +89,7 @@ The type stored in the wxList nodes. @library{wxbase} - @category{data} + @category{containers} @see wxArray, wxVector, wxNode */ diff --git a/interface/wx/listbook.h b/interface/wx/listbook.h index 5683d89c4b..dc8001dd3d 100644 --- a/interface/wx/listbook.h +++ b/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 diff --git a/interface/wx/listctrl.h b/interface/wx/listctrl.h index 7547e8b3e2..064313ce9b 100644 --- a/interface/wx/listctrl.h +++ b/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 */ diff --git a/interface/wx/metafile.h b/interface/wx/metafile.h index 8d4f7c3b28..cf541c567e 100644 --- a/interface/wx/metafile.h +++ b/interface/wx/metafile.h @@ -69,7 +69,7 @@ public: @onlyfor{wxmsw} @library{wxcore} - @category{gdi,misc} + @category{gdi} @see wxMetafileDC */ diff --git a/interface/wx/mimetype.h b/interface/wx/mimetype.h index 05c0f1aee7..dc2244c1d5 100644 --- a/interface/wx/mimetype.h +++ b/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 */ diff --git a/interface/wx/module.h b/interface/wx/module.h index 289530f872..a6a091e613 100644 --- a/interface/wx/module.h +++ b/interface/wx/module.h @@ -73,7 +73,7 @@ @endcode @library{wxbase} - @category{misc} + @category{appmanagement} */ class wxModule : public wxObject { diff --git a/interface/wx/msgqueue.h b/interface/wx/msgqueue.h index 5a6347f794..3c3432f8a2 100644 --- a/interface/wx/msgqueue.h +++ b/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 class wxMessageQueue { public: diff --git a/interface/wx/msw/ole/activex.h b/interface/wx/msw/ole/activex.h index 19f50d265d..d69892ba83 100644 --- a/interface/wx/msw/ole/activex.h +++ b/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 */ diff --git a/interface/wx/msw/ole/automtn.h b/interface/wx/msw/ole/automtn.h index f29b9f86c0..22f47a1d8d 100644 --- a/interface/wx/msw/ole/automtn.h +++ b/interface/wx/msw/ole/automtn.h @@ -33,7 +33,7 @@ @onlyfor{wxmsw} @library{wxcore} - @category{misc} + @category{data} @see wxVariant */ diff --git a/interface/wx/msw/registry.h b/interface/wx/msw/registry.h index d1c83ff48e..cf1c200c7e 100644 --- a/interface/wx/msw/registry.h +++ b/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); diff --git a/interface/wx/notebook.h b/interface/wx/notebook.h index 863c01f991..19b575d27e 100644 --- a/interface/wx/notebook.h +++ b/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 diff --git a/interface/wx/platinfo.h b/interface/wx/platinfo.h index a9a2c687eb..06eff6cb08 100644 --- a/interface/wx/platinfo.h +++ b/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 diff --git a/interface/wx/settings.h b/interface/wx/settings.h index 9acd7d301e..8fcb3ba59f 100644 --- a/interface/wx/settings.h +++ b/interface/wx/settings.h @@ -163,7 +163,7 @@ enum wxSystemScreenType and user interface element sizes. @library{wxcore} - @category{misc} + @category{cfg} @see wxFont, wxColour */ diff --git a/interface/wx/snglinst.h b/interface/wx/snglinst.h index 4ea2d84bb9..4d240abe65 100644 --- a/interface/wx/snglinst.h +++ b/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 { diff --git a/interface/wx/sound.h b/interface/wx/sound.h index b4e65d0e50..862f93289d 100644 --- a/interface/wx/sound.h +++ b/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 { diff --git a/interface/wx/stc/stc.h b/interface/wx/stc/stc.h index 6338d312bc..ff4494dcf9 100644 --- a/interface/wx/stc/stc.h +++ b/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 { diff --git a/interface/wx/sysopt.h b/interface/wx/sysopt.h index ec08a7d28a..ef436266b4 100644 --- a/interface/wx/sysopt.h +++ b/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 */ diff --git a/interface/wx/toolbook.h b/interface/wx/toolbook.h index ea4e48be83..96846cb262 100644 --- a/interface/wx/toolbook.h +++ b/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 diff --git a/interface/wx/treebase.h b/interface/wx/treebase.h index 4218dac815..4961f66781 100644 --- a/interface/wx/treebase.h +++ b/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 */ diff --git a/interface/wx/treebook.h b/interface/wx/treebook.h index 41b74df811..5a5e8a5dae 100644 --- a/interface/wx/treebook.h +++ b/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 diff --git a/interface/wx/vidmode.h b/interface/wx/vidmode.h index ec2e197527..ef6a3af909 100644 --- a/interface/wx/vidmode.h +++ b/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 diff --git a/interface/wx/windowid.h b/interface/wx/windowid.h index 2f0308d551..002c11eb00 100644 --- a/interface/wx/windowid.h +++ b/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 diff --git a/interface/wx/xlocale.h b/interface/wx/xlocale.h index a6809a13b7..4d36bea6d6 100644 --- a/interface/wx/xlocale.h +++ b/interface/wx/xlocale.h @@ -61,7 +61,7 @@ IO) in the near future. @library{wxbase} - @category{misc} + @category{cfg} @see wxLocale */ -- 2.45.2