From 77bfb902226a65423999d6d5f15d68ea5398587f Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sat, 4 Oct 2008 14:52:38 +0000 Subject: [PATCH] fix many doxygen warnings about undocumented parameters git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56079 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/bmpcbox.h | 20 ++++++++++++++++++++ interface/wx/dcsvg.h | 17 ++++++++--------- interface/wx/filepicker.h | 2 +- interface/wx/textdlg.h | 2 ++ interface/wx/tglbtn.h | 2 +- interface/wx/toplevel.h | 23 +++++++++++++++++------ interface/wx/utils.h | 9 +++++++-- interface/wx/window.h | 12 ++++++++---- interface/wx/xml/xml.h | 2 ++ 9 files changed, 66 insertions(+), 23 deletions(-) diff --git a/interface/wx/bmpcbox.h b/interface/wx/bmpcbox.h index c5ba7aa7ff..f74407e000 100644 --- a/interface/wx/bmpcbox.h +++ b/interface/wx/bmpcbox.h @@ -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 */ diff --git a/interface/wx/dcsvg.h b/interface/wx/dcsvg.h index ccf2f89689..3536612216 100644 --- a/interface/wx/dcsvg.h +++ b/interface/wx/dcsvg.h @@ -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() */ diff --git a/interface/wx/filepicker.h b/interface/wx/filepicker.h index 6fdd64aa5c..35b0efd480 100644 --- a/interface/wx/filepicker.h +++ b/interface/wx/filepicker.h @@ -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. diff --git a/interface/wx/textdlg.h b/interface/wx/textdlg.h index 9147e419e4..e61352fe24 100644 --- a/interface/wx/textdlg.h +++ b/interface/wx/textdlg.h @@ -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 diff --git a/interface/wx/tglbtn.h b/interface/wx/tglbtn.h index 3f6d601528..aed1a940a8 100644 --- a/interface/wx/tglbtn.h +++ b/interface/wx/tglbtn.h @@ -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. diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h index 4dcac9e2e3..69aa5a6bf1 100644 --- a/interface/wx/toplevel.h +++ b/interface/wx/toplevel.h @@ -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); diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 1254434a7b..647519a15d 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -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 diff --git a/interface/wx/window.h b/interface/wx/window.h index 518dcb614d..98d7a1a344 100644 --- a/interface/wx/window.h +++ b/interface/wx/window.h @@ -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 diff --git a/interface/wx/xml/xml.h b/interface/wx/xml/xml.h index c66ce74ca5..fccaf5341f 100644 --- a/interface/wx/xml/xml.h +++ b/interface/wx/xml/xml.h @@ -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 -- 2.45.2