]> git.saurik.com Git - wxWidgets.git/commitdiff
more Doxygen warnings corrections from Tim S
authorVadim Zeitlin <vadim@wxwidgets.org>
Sat, 30 Aug 2008 12:44:43 +0000 (12:44 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Sat, 30 Aug 2008 12:44:43 +0000 (12:44 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55367 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/calctrl.h
interface/wx/checkbox.h
interface/wx/checklst.h
interface/wx/choicdlg.h
interface/wx/choice.h
interface/wx/combobox.h
interface/wx/listctrl.h
interface/wx/odcombo.h
interface/wx/tls.h

index 7b0388416d7517aa66761e16aae9576887e14303..e72e0bf4e6cd8f7e73d731293179a902f61d6dc1 100644 (file)
@@ -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
index 82ed45ac9d94540c0b566ad15dfa570b8add12bb..2692382df3d947bc31b31604f05df1fa3b26121d 100644 (file)
@@ -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");
 
     /**
index 041dafc3696c5fd506f340a99dc8ea2872908d02..bb1421167f4e6120e40e31d6a0547d2c61e06f9d 100644 (file)
@@ -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,
index 2a04b8c07083eef8db1042477cdf66fa1825392f..f9dcbc5d578f6af8b0d9e4e5308388df2865111b 100644 (file)
@@ -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,
index 4a6211a5d97b2701ff4c56ccde5deb790773455d..57e03c6dfc8640e71c012804564f1d9d97dfdfb8 100644 (file)
@@ -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,
index adf9ec3ddbb843956d26c708a05442a61ce4bdc9..f0a56fa4a498eab244cf077af5e494c470f08569 100644 (file)
@@ -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,
index f5aa9486916be755322b2638d73a89f382b95fca..8dd9cc3ecdcd7adae6e88b4ffc4992280ba90faf 100644 (file)
@@ -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
index 50db36ccbdd87b9c7fac8556e1d4b504362e2b92..7edc546717b0683b3dd5aec017b9c08d3131c578 100644 (file)
@@ -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,
index aa86dec70445012ccfd60d23b2af78b8a8e3002e..64d172609b779a494b0cbac509bf3a0583feb3e2 100644 (file)
@@ -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.