From: Vadim Zeitlin Date: Sat, 30 Aug 2008 12:44:43 +0000 (+0000) Subject: more Doxygen warnings corrections from Tim S X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/792255cc6d3dfd55626c821bb8fdea48bfe919ba?ds=inline more Doxygen warnings corrections from Tim S git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/interface/wx/calctrl.h b/interface/wx/calctrl.h index 7b0388416d..e72e0bf4e6 100644 --- a/interface/wx/calctrl.h +++ b/interface/wx/calctrl.h @@ -493,7 +493,7 @@ public: @param lowerdate The low limit for the dates shown by the control or @c wxDefaultDateTime. - @param highlighting + @param upperdate The high limit for the dates shown by the control or @c wxDefaultDateTime. @return diff --git a/interface/wx/checkbox.h b/interface/wx/checkbox.h index 82ed45ac9d..2692382df3 100644 --- a/interface/wx/checkbox.h +++ b/interface/wx/checkbox.h @@ -90,7 +90,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, - const wxValidator& val = wxDefaultValidator, + const wxValidator& validator = wxDefaultValidator, const wxString& name = "checkBox"); /** @@ -107,7 +107,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, - const wxValidator& val = wxDefaultValidator, + const wxValidator& validator = wxDefaultValidator, const wxString& name = "checkBox"); /** diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h index 041dafc369..bb1421167f 100644 --- a/interface/wx/checklst.h +++ b/interface/wx/checklst.h @@ -67,11 +67,32 @@ public: wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - int n, + int n = 0, const wxString choices[] = NULL, long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listBox"); + /** + Constructor, creating and showing a list box. + + @param parent + Parent window. Must not be @NULL. + @param id + Window identifier. The value wxID_ANY indicates a default value. + @param pos + Window position. + @param size + Window size. If wxDefaultSize is specified then the window is sized + appropriately. + @param choices + An array of strings with which to initialise the control. + @param style + Window style. See wxCheckListBox. + @param validator + Window validator. + @param name + Window name. + */ wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, diff --git a/interface/wx/choicdlg.h b/interface/wx/choicdlg.h index 2a04b8c070..f9dcbc5d57 100644 --- a/interface/wx/choicdlg.h +++ b/interface/wx/choicdlg.h @@ -66,6 +66,44 @@ public: int n, const wxString* choices, long style = wxCHOICEDLG_STYLE, const wxPoint& pos = wxDefaultPosition); + /** + Constructor taking an array of wxString choices. + + @param parent + Parent window. + @param message + Message to show on the dialog. + @param caption + The dialog caption. + @param choices + An array of strings, or a string list, containing the choices. + @param style + A dialog style (bitlist) containing flags chosen from standard + dialog style and the ones listed below. The default value is + equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK | + wxCANCEL | wxCENTRE. + @param pos + Dialog position. Not Windows. + + @beginStyleTable + @style{wxOK} + Show an OK button. + @style{wxCANCEL} + Show a Cancel button. + @style{wxCENTRE} + Centre the message. Not Windows. + @endStyleTable + + @remarks Use ShowModal() to show the dialog. + + @beginWxPythonOnly + + For Python the two parameters @a n and @a choices are collapsed into a + multi parameter @a choices which is expected to be a Python list of + strings. + + @endWxPythonOnly + */ wxMultiChoiceDialog(wxWindow* parent, const wxString& message, const wxString& caption, @@ -158,6 +196,48 @@ public: void** clientData = NULL, long style = wxCHOICEDLG_STYLE, const wxPoint& pos = wxDefaultPosition); + /** + Constructor, taking an array of wxString choices and optional client + data. + + @param parent + Parent window. + @param message + Message to show on the dialog. + @param caption + The dialog caption. + @param choices + An array of strings, or a string list, containing the choices. + @param clientData + An array of client data to be associated with the items. See + GetSelectionClientData(). + @param style + A dialog style (bitlist) containing flags chosen from standard + dialog styles and the ones listed below. The default value is + equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK | + wxCANCEL | wxCENTRE. + @param pos + Dialog position. Not Windows. + + @beginStyleTable + @style{wxOK} + Show an OK button. + @style{wxCANCEL} + Show a Cancel button. + @style{wxCENTRE} + Centre the message. Not Windows. + @endStyleTable + + @remarks Use ShowModal() to show the dialog. + + @beginWxPythonOnly + + For Python the two parameters @a n and @a choices are collapsed into a + multi parameter @a choices which is expected to be a Python list of + strings. + + @endWxPythonOnly + */ wxSingleChoiceDialog(wxWindow* parent, const wxString& message, const wxString& caption, diff --git a/interface/wx/choice.h b/interface/wx/choice.h index 4a6211a5d9..57e03c6dfc 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -80,6 +80,37 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "choice"); + + /** + Constructor, creating and showing a choice. + + @param parent + Parent window. Must not be @NULL. + @param id + Window identifier. The value wxID_ANY indicates a default value. + @param pos + Window position. + @param size + Window size. If wxDefaultSize is specified then the choice is sized + appropriately. + @param choices + An array of strings with which to initialise the choice control. + @param style + Window style. See wxChoice. + @param validator + Window validator. + @param name + Window name. + + @see Create(), wxValidator + + @beginWxPythonOnly + + The wxChoice constructor in wxPython reduces the @a n and @a choices + arguments to a single argument, which is a list of strings. + + @endWxPythonOnly + */ wxChoice(wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index adf9ec3ddb..f0a56fa4a4 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -107,6 +107,36 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "comboBox"); + /** + Constructor, creating and showing a combobox. + + @param parent + Parent window. Must not be @NULL. + @param id + Window identifier. The value wxID_ANY indicates a default value. + @param value + Initial selection string. An empty string indicates no selection. + @param pos + Window position. + @param size + Window size. If wxDefaultSize is specified then the window is sized + appropriately. + @param choices + An array of strings with which to initialise the control. + @param style + Window style. See wxComboBox. + @param validator + Window validator. + @param name + Window name. + + @beginWxPythonOnly + The wxComboBox constructor in wxPython reduces the @a n and @a choices + arguments are to a single argument, which is a list of strings. + @endWxPythonOnly + + @see Create(), wxValidator + */ wxComboBox(wxWindow* parent, wxWindowID id, const wxString& value, const wxPoint& pos, diff --git a/interface/wx/listctrl.h b/interface/wx/listctrl.h index f5aa948691..8dd9cc3ecd 100644 --- a/interface/wx/listctrl.h +++ b/interface/wx/listctrl.h @@ -1211,7 +1211,7 @@ public: @see wxListCtrl::SetItemState */ - void Select(bool on = true); + void Select(long n, bool on = true); /** Sets the column image for the specified column. To use the column images, the diff --git a/interface/wx/odcombo.h b/interface/wx/odcombo.h index 50db36ccbd..7edc546717 100644 --- a/interface/wx/odcombo.h +++ b/interface/wx/odcombo.h @@ -105,6 +105,31 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "comboBox"); + /** + Constructor, creating and showing a owner-drawn combobox. + + @param parent + Parent window. Must not be @NULL. + @param id + Window identifier. The value @c wxID_ANY indicates a default value. + @param value + Initial selection string. An empty string indicates no selection. + @param pos + Window position. + @param size + Window size. + If ::wxDefaultSize is specified then the window is sized appropriately. + @param choices + An array of strings with which to initialise the control. + @param style + Window style. See wxOwnerDrawnComboBox. + @param validator + Window validator. + @param name + Window name. + + @see Create(), wxValidator + */ wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, const wxString& value, const wxPoint& pos, diff --git a/interface/wx/tls.h b/interface/wx/tls.h index aa86dec704..64d172609b 100644 --- a/interface/wx/tls.h +++ b/interface/wx/tls.h @@ -46,7 +46,7 @@ type emulating @c T @c *, i.e. a pointer to this type otherwise. This macro always returns an expression of type @c T itself. - As shown in wxTLS_TYPE() example, you may want to @c #define a symbol + As shown in wxTLS_TYPE() example, you may want to @c \#define a symbol wrapping a thread-specific variable with this macro. And, as also explained in wxTLS_TYPE() documentation, you may avoid using it entirely if you target only recent compilers.