]> git.saurik.com Git - wxWidgets.git/commitdiff
fix many doxygen warnings about undocumented parameters
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Sat, 4 Oct 2008 14:52:38 +0000 (14:52 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Sat, 4 Oct 2008 14:52:38 +0000 (14:52 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56079 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/bmpcbox.h
interface/wx/dcsvg.h
interface/wx/filepicker.h
interface/wx/textdlg.h
interface/wx/tglbtn.h
interface/wx/toplevel.h
interface/wx/utils.h
interface/wx/window.h
interface/wx/xml/xml.h

index c5ba7aa7ff832a321646232bfe6d1923c18a31e8..f74407e000f9791310905e9ec161c1e6aa513cc1 100644 (file)
@@ -70,10 +70,20 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.
+        @param pos
+            Initial position.
+        @param size
+            Initial size.
         @param n
             Number of strings with which to initialise the control.
         @param choices
             An array of strings with which to initialise the control.
+        @param style
+            The window style, see wxCB_* flags.
+        @param validator
+            Validator which can be used for additional data checks.
+        @param name
+            Control name.
 
         @see Create(), wxValidator
     */
@@ -96,8 +106,18 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.
+        @param pos
+            Initial position.
+        @param size
+            Initial size.
         @param choices
             An wxArrayString with which to initialise the control.
+        @param style
+            The window style, see wxCB_* flags.
+        @param validator
+            Validator which can be used for additional data checks.
+        @param name
+            Control name.
 
         @see Create(), wxValidator
     */
index ccf2f896894c6591ae728d0215c36f6abe0dbdfd..35366122169e1b277df45660599d2f53f51b26e6 100644 (file)
@@ -279,14 +279,13 @@ public:
 
     /**
         Draws a spline between all given control points, using the current pen.
-        The programmer is responsible for deleting the list of points. The
-        spline is drawn using a series of lines, using an algorithm taken from
+        The programmer is responsible for deleting the list of points.
+        The spline is drawn using a series of lines, using an algorithm taken from
         the X drawing program "XFIG".
     */
     void DrawSpline(wxList* points);
+
     /**
-        @param string
-            The text string to measure.
         Draws a three-point spline using the current pen.
     */
     void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
@@ -417,7 +416,7 @@ public:
         @see SetTextBackground()
     */
     wxColour GetTextBackground() const;
-    const wxColour GetTextBackground() const;
+    const wxColour& GetTextBackground() const;
     //@}
 
     /**
@@ -435,10 +434,10 @@ public:
         @param externalLeading
             Any extra vertical space added to the font by the font designer
             (usually is zero).
-
-        The optional parameter @a font specifies an alternative to the
-        currently selected font: but note that this does not yet work under
-        Windows, so you need to set a font for the device context first.
+        @param font
+            Specifies an alternative to the currently selected font: but note
+            that this does not yet work under Windows, so you need to set a
+            font for the device context first.
 
         @see wxFont, SetFont()
     */
index 6fdd64aa5c2f6b6b916e6cedfe6a9c51b67d48ee..35b0efd4806b10cc815e0fbfec5d3063e89f5856 100644 (file)
@@ -93,7 +93,7 @@ public:
         @param style
             The window style, see wxFLP_* flags.
         @param validator
-            Validator which can be used for additional date checks.
+            Validator which can be used for additional data checks.
         @param name
             Control name.
 
index 9147e419e4ee51f4a5c4535885be6fcced16c07a..e61352fe241c1535b542c2db45cadd182f5bbb38 100644 (file)
@@ -70,6 +70,8 @@ public:
             Parent window.
         @param message
             Message to show on the dialog.
+        @param caption
+            The caption of the the dialog.
         @param defaultValue
             The default value, which may be the empty string.
         @param style
index 3f6d601528447ba54e79b8fae36f35a7336c786e..aed1a940a836a7561c39a1ad8c27d15a2876197c 100644 (file)
@@ -53,7 +53,7 @@ public:
             If wxDefaultSize is specified then a default size is chosen.
         @param style
             Window style. See wxToggleButton.
-        @param validator
+        @param val
             Window validator.
         @param name
             Window name.
index 4dcac9e2e395cf3d387da453ed5362ac7c14ceeb..69aa5a6bf16125eb0f3e076dc3bcfc95e5722293 100644 (file)
@@ -275,7 +275,7 @@ public:
             Identifier for this button.
         @param label
             Text to be displayed on the screen area dedicated to this hardware
-            button. 
+            button.
         @param subMenu
             The menu to be opened after pressing this hardware button.
 
@@ -299,6 +299,14 @@ public:
         size increments. If a pair of values is not set (or set to -1), no
         constraints will be used.
 
+        @param minW
+            The minimum width.
+        @param minH
+            The minimum height.
+        @param maxW
+            The maximum width.
+        @param maxH
+            The maximum height.
         @param incW
             Specifies the increment for sizing the width (GTK/Motif/Xt only).
         @param incH
@@ -310,16 +318,19 @@ public:
                  wxWindow::SetSize().
 
     */
-    virtual void SetSizeHints(int minW, int minH, int maxW = -1,
-                              int maxH = -1,
-                              int incW = -1,
-                              int incH = -1);
+    virtual void SetSizeHints(int minW, int minH,
+                              int maxW = -1, int maxH = -1,
+                              int incW = -1, int incH = -1);
 
     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no
         constraints will be used.
 
+        @param minSize
+            The minimum size of the window.
+        @param maxSize
+            The maximum size of the window.
         @param incSize
             Increment size (only taken into account under X11-based ports such
             as wxGTK/wxMotif/wxX11).
@@ -417,7 +428,7 @@ public:
         decorations are used by default and so it may make sense to call this
         method with default argument if the application can't use custom
         decorations at all for some reason.
-        
+
         @see UseNativeDecorations()
     */
     void UseNativeDecorationsByDefault(bool native = true);
index 1254434a7b0395bd66056a8a3008728f07cf39c4..647519a15d12f6b207f67c4031763ef667fac2b5 100644 (file)
@@ -768,6 +768,8 @@ long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC,
     @param command
         The command to execute and any parameters to pass to it as a single
         string.
+    @param output
+        The string array where the stdout of the executed process is saved.
     @param flags
         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
@@ -776,8 +778,7 @@ long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC,
 
     @header{wx/utils.h}
 */
-long wxExecute(const wxString& command, wxArrayString& output,
-                int flags = 0);
+long wxExecute(const wxString& command, wxArrayString& output, int flags = 0);
 
 /**
     This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
@@ -789,6 +790,10 @@ long wxExecute(const wxString& command, wxArrayString& output,
     @param command
         The command to execute and any parameters to pass to it as a single
         string.
+    @param output
+        The string array where the stdout of the executed process is saved.
+    @param errors
+        The string array where the stderr of the executed process is saved.
     @param flags
         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
index 518dcb614d2081d61d9447b9341002581f246cd1..98d7a1a34430069a67e14be21d230c82edba2c8e 100644 (file)
@@ -1522,7 +1522,7 @@ public:
         Disables all other windows in the application so that
         the user can only interact with this window.
 
-        @param flag
+        @param modal
             If @true, this call disables all other windows in the application so that
             the user can only interact with this window. If @false, the effect is
             reversed.
@@ -1536,6 +1536,8 @@ public:
             Required x position.
         @param y
             Required y position.
+        @param flags
+            See SetSize() for more info about this parameter.
 
         @remarks Implementations of SetSize can also implicitly implement the
                  Move() function, which is defined in the base wxWindow class as the call:
@@ -1545,13 +1547,15 @@ public:
 
         @see SetSize()
     */
-    void Move(int x, int y, int flags = 0);
+    void Move(int x, int y, int flags = wxSIZE_USE_EXISTING);
 
     /**
         Moves the window to the given position.
 
         @param pt
             wxPoint object representing the position.
+        @param flags
+            See SetSize() for more info about this parameter.
 
         @remarks Implementations of SetSize() can also implicitly implement the
                  Move() function, which is defined in the base wxWindow class as the call:
@@ -1561,7 +1565,7 @@ public:
 
         @see SetSize()
     */
-    void Move(const wxPoint& pt, int flags = 0);
+    void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING);
 
     /**
         Moves this window in the tab navigation order after the specified @e win.
@@ -1921,7 +1925,7 @@ public:
                               const wxRect* rect = NULL);
 
     /**
-        This function sends a dummy @ref overview_wxsizeevent "size event" to
+        This function sends a dummy @ref wxSizeEvent "size event" to
         the window allowing it to re-layout its children positions.
 
         It is sometimes useful to call this function after adding or deleting a
index c66ce74ca5912bbd0785e1d082a6bd25ef61e3d1..fccaf5341f76cc0089e873fd2654e8aab9cb8530 100644 (file)
@@ -263,6 +263,8 @@ public:
         @return @true if @a precedingNode has been found and the @a child
                 node has been inserted.
 
+        @param child
+            The child to insert.
         @param precedingNode
             The node to insert @a child after. As a special case, this can be
             @NULL if this node has no children yet -- in that case, @a child