From d29a9a8ac8ab0467c8a3c076b147a0942011f7ee Mon Sep 17 00:00:00 2001 From: Bryan Petty Date: Sun, 11 May 2008 01:38:53 +0000 Subject: [PATCH] Replaced @returns with @return for more standard command use and compatibility. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53549 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/generic/progdlgg.h | 2 +- interface/accel.h | 4 +-- interface/access.h | 5 ++- interface/animate.h | 8 ++--- interface/app.h | 3 +- interface/artprov.h | 8 ++--- interface/base64.h | 2 +- interface/bitmap.h | 20 +++++------ interface/bmpbuttn.h | 8 ++--- interface/button.h | 2 +- interface/checkbox.h | 12 +++---- interface/clipbrd.h | 6 ++-- interface/clrpicker.h | 4 +-- interface/cmdproc.h | 16 ++++----- interface/collpane.h | 4 +-- interface/combo.h | 20 +++++------ interface/config.h | 16 ++++----- interface/cshelp.h | 4 +-- interface/ctrlsub.h | 54 ++++++++++++++-------------- interface/dataobj.h | 2 +- interface/datectrl.h | 4 +-- interface/datetime.h | 66 +++++++++++++++++------------------ interface/dc.h | 4 +-- interface/dde.h | 14 ++++---- interface/debugrpt.h | 6 ++-- interface/dialog.h | 2 +- interface/dialup.h | 2 +- interface/dnd.h | 12 +++---- interface/dynlib.h | 2 +- interface/event.h | 6 ++-- interface/ffile.h | 6 ++-- interface/file.h | 4 +-- interface/filectrl.h | 6 ++-- interface/filefn.h | 2 +- interface/filename.h | 12 +++---- interface/filepicker.h | 4 +-- interface/fontpicker.h | 2 +- interface/frame.h | 8 ++--- interface/gbsizer.h | 2 +- interface/gdicmn.h | 2 +- interface/html/htmlcell.h | 2 +- interface/html/htmlpars.h | 2 +- interface/html/htmlwin.h | 10 +++--- interface/icon.h | 2 +- interface/image.h | 32 +++++++++-------- interface/imaglist.h | 6 ++-- interface/intl.h | 4 +-- interface/joystick.h | 4 +-- interface/listbox.h | 6 ++-- interface/listctrl.h | 4 +-- interface/memory.h | 4 +-- interface/menu.h | 50 +++++++++++++------------- interface/msw/ole/automtn.h | 2 +- interface/notebook.h | 6 ++-- interface/object.h | 4 +-- interface/palette.h | 6 ++-- interface/process.h | 2 +- interface/protocol/ftp.h | 8 ++--- interface/protocol/http.h | 2 +- interface/protocol/protocol.h | 6 ++-- interface/region.h | 12 +++---- interface/sizer.h | 4 +-- interface/snglinst.h | 2 +- interface/socket.h | 48 ++++++++++++------------- interface/sound.h | 2 +- interface/splitter.h | 6 ++-- interface/statusbr.h | 4 +-- interface/strconv.h | 2 +- interface/stream.h | 10 +++--- interface/textctrl.h | 24 ++++++------- interface/tglbtn.h | 4 +-- interface/thread.h | 20 +++++------ interface/toolbar.h | 10 +++--- interface/url.h | 2 +- interface/utils.h | 18 +++++----- interface/validate.h | 2 +- interface/vlbox.h | 10 +++--- interface/vscroll.h | 16 ++++----- interface/window.h | 34 +++++++++--------- interface/windowid.h | 2 +- interface/wxcrt.h | 6 ++-- 81 files changed, 383 insertions(+), 383 deletions(-) diff --git a/include/wx/generic/progdlgg.h b/include/wx/generic/progdlgg.h index 32383adb59..a3ff1a8f02 100644 --- a/include/wx/generic/progdlgg.h +++ b/include/wx/generic/progdlgg.h @@ -50,7 +50,7 @@ public: /* Update the status bar to the new value. @param value new value @param newmsg if used, new message to display - @returns true if ABORT button has not been pressed + @return true if ABORT button has not been pressed */ virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL); diff --git a/interface/accel.h b/interface/accel.h index 2763733330..616f2b047a 100644 --- a/interface/accel.h +++ b/interface/accel.h @@ -116,8 +116,8 @@ public: @param str Should be a string in the form "flags-keycode" - @returns @true if the given string correctly initialized this object - (i.e. if IsOk() returns true after this call) + @return @true if the given string correctly initialized this object + (i.e. if IsOk() returns true after this call) */ bool FromString(const wxString& str); diff --git a/interface/access.h b/interface/access.h index ec95d396ca..4579aabc25 100644 --- a/interface/access.h +++ b/interface/access.h @@ -274,9 +274,8 @@ public: @a childId is 0 (the action for this object) or greater than 0 (the action for a child). - @returns - wxACC_NOT_SUPPORTED if there is no default action for this window - (e.g. an edit control). + @return wxACC_NOT_SUPPORTED if there is no default action for this + window (e.g. an edit control). */ virtual wxAccStatus DoDefaultAction(int childId); diff --git a/interface/animate.h b/interface/animate.h index 0224b8fb05..7d7e3e3403 100644 --- a/interface/animate.h +++ b/interface/animate.h @@ -90,8 +90,8 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if - creation failed. + @return @true if the control was successfully created or @false if + creation failed. */ bool Create(wxWindow* parent, wxWindowID id, const wxAnimation& anim = wxNullAnimation, @@ -246,7 +246,7 @@ public: @li wxANIMATION_TYPE_ANI: load an ANI file; @li wxANIMATION_TYPE_ANY: tries to autodetect the filetype. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. */ virtual bool Load(wxInputStream& stream, wxAnimationType type = wxANIMATION_TYPE_ANY); @@ -260,7 +260,7 @@ public: One of the wxAnimationType values; wxANIMATION_TYPE_ANY means that the function should try to autodetect the filetype. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. */ virtual bool LoadFile(const wxString& name, wxAnimationType type = wxANIMATION_TYPE_ANY); diff --git a/interface/app.h b/interface/app.h index 9577e621fa..cf79e46a12 100644 --- a/interface/app.h +++ b/interface/app.h @@ -203,8 +203,7 @@ public: Called by wxWidgets on creation of the application. Override this if you wish to provide your own (environment-dependent) main loop. - @returns Returns 0 under X, and the wParam of the WM_QUIT message under - Windows. + @return 0 under X, and the wParam of the WM_QUIT message under Windows. */ virtual int MainLoop(); diff --git a/interface/artprov.h b/interface/artprov.h index e6e13df265..fc50474b81 100644 --- a/interface/artprov.h +++ b/interface/artprov.h @@ -178,8 +178,8 @@ public: @param size Size of the returned bitmap or wxDefaultSize if size doesn't matter. - @returns The bitmap if one of registered providers recognizes the ID or - wxNullBitmap otherwise. + @return The bitmap if one of registered providers recognizes the ID or + wxNullBitmap otherwise. */ static wxBitmap GetBitmap(const wxArtID& id, const wxArtClient& client = wxART_OTHER, @@ -212,8 +212,8 @@ public: wxArtClient identifier of the client (i.e. who is asking for the icon bundle). - @returns The icon bundle if one of registered providers recognizes the ID - or wxNullIconBundle otherwise. + @return The icon bundle if one of registered providers recognizes the ID + or wxNullIconBundle otherwise. */ static wxIconBundle GetIconBundle(const wxArtID& id, const wxArtClient& client = wxART_OTHER); diff --git a/interface/base64.h b/interface/base64.h index 2162513bf4..3967d697b9 100644 --- a/interface/base64.h +++ b/interface/base64.h @@ -33,7 +33,7 @@ @param srcLen The length of the input data. - @returns @c wxCONV_FAILED if the output buffer is too small. + @return @c wxCONV_FAILED if the output buffer is too small. @header{wx/base64.h} */ diff --git a/interface/bitmap.h b/interface/bitmap.h index 41fa0c644b..1bcf959e19 100644 --- a/interface/bitmap.h +++ b/interface/bitmap.h @@ -64,7 +64,7 @@ public: A bitmap type identifier - see ::wxBitmapType for a list of possible values. - @returns @true if the call succeeded, @false otherwise (the default). + @return @true if the call succeeded, @false otherwise (the default). */ virtual bool Create(wxBitmap* bitmap, const void* data, wxBitmapType type, int width, int height, int depth = 1); @@ -100,7 +100,7 @@ public: @param desiredHeight The desired height for the loaded bitmap. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile() */ @@ -119,7 +119,7 @@ public: @param palette An optional palette used for saving the bitmap. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile() */ @@ -376,7 +376,7 @@ public: @param depth The depth of the bitmap in pixels. If this is -1, the screen depth is used. - @returns @true if the call succeeded, @false otherwise. + @return @true if the call succeeded, @false otherwise. This overload depends on the @a type of data. @@ -389,7 +389,7 @@ public: /** Finds the handler with the given @a name. - @returns A pointer to the handler if found, @NULL otherwise. + @return A pointer to the handler if found, @NULL otherwise. */ static wxBitmapHandler* FindHandler(const wxString& name); @@ -401,7 +401,7 @@ public: @param bitmapType The bitmap type managed by the handler, see ::wxBitmapType. - @returns A pointer to the handler if found, @NULL otherwise. + @return A pointer to the handler if found, @NULL otherwise. */ static wxBitmapHandler* FindHandler(const wxString& extension, wxBitmapType bitmapType); @@ -412,7 +412,7 @@ public: @param bitmapType The bitmap type managed by the handler, see ::wxBitmapType. - @returns A pointer to the handler if found, @NULL otherwise. + @return A pointer to the handler if found, @NULL otherwise. @see wxBitmapHandler */ @@ -503,7 +503,7 @@ public: One of the ::wxBitmapType values; see the note in the class detailed description. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @remarks A palette may be associated with the bitmap if one exists (especially for colour Windows bitmaps), and if the @@ -521,7 +521,7 @@ public: @param name The handler name. - @returns @true if the handler was found and removed, @false otherwise. + @return @true if the handler was found and removed, @false otherwise. @see wxBitmapHandler */ @@ -538,7 +538,7 @@ public: @param palette An optional palette used for saving the bitmap. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @remarks Depending on how wxWidgets has been configured, not all formats may be available. diff --git a/interface/bmpbuttn.h b/interface/bmpbuttn.h index f7297b01b2..89dcca9677 100644 --- a/interface/bmpbuttn.h +++ b/interface/bmpbuttn.h @@ -131,7 +131,7 @@ public: /** Returns the bitmap for the disabled state, which may be invalid. - @returns A reference to the disabled state bitmap. + @return A reference to the disabled state bitmap. @see SetBitmapDisabled() */ @@ -143,7 +143,7 @@ public: /** Returns the bitmap for the focused state, which may be invalid. - @returns A reference to the focused state bitmap. + @return A reference to the focused state bitmap. @see SetBitmapFocus() */ @@ -165,7 +165,7 @@ public: /** Returns the label bitmap (the one passed to the constructor), always valid. - @returns A reference to the button's label bitmap. + @return A reference to the button's label bitmap. @see SetBitmapLabel() */ @@ -176,7 +176,7 @@ public: /** Returns the bitmap for the selected state. - @returns A reference to the selected state bitmap. + @return A reference to the selected state bitmap. @see SetBitmapSelected() */ diff --git a/interface/button.h b/interface/button.h index 0c9d66734e..67e13cc77f 100644 --- a/interface/button.h +++ b/interface/button.h @@ -131,7 +131,7 @@ public: @remarks Under Windows, only dialog box buttons respond to this function. - @returns the old default item (possibly NULL) + @return the old default item (possibly NULL) */ virtual wxWindow* SetDefault(); diff --git a/interface/checkbox.h b/interface/checkbox.h index 944f9b248c..e0f584b3b6 100644 --- a/interface/checkbox.h +++ b/interface/checkbox.h @@ -114,7 +114,7 @@ public: /** Gets the state of a 2-state checkbox. - @returns Returns @true if it is checked, @false otherwise. + @return Returns @true if it is checked, @false otherwise. */ bool GetValue() const; @@ -127,8 +127,8 @@ public: /** Returns whether or not the checkbox is a 3-state checkbox. - @returns Returns @true if this checkbox is a 3-state checkbox, @false - if it's a 2-state checkbox. + @return @true if this checkbox is a 3-state checkbox, @false if it's + a 2-state checkbox. */ bool Is3State() const; @@ -136,9 +136,9 @@ public: Returns whether or not the user can set the checkbox to the third state. - @returns Returns @true if the user can set the third state of this - checkbox, @false if it can only be set programmatically or if - it's a 2-state checkbox. + @return @true if the user can set the third state of this checkbox, + @false if it can only be set programmatically or if it's a + 2-state checkbox. */ bool Is3rdStateAllowedForUser() const; diff --git a/interface/clipbrd.h b/interface/clipbrd.h index b97503e504..307793295c 100644 --- a/interface/clipbrd.h +++ b/interface/clipbrd.h @@ -103,7 +103,7 @@ public: (possibly eating memory), otherwise the clipboard will be emptied on exit. - @returns @false if the operation is unsuccessful for any reason. + @return @false if the operation is unsuccessful for any reason. */ bool Flush(); @@ -142,8 +142,8 @@ public: Call Close() when you have finished with the clipboard. You should keep the clipboard open for only a very short time. - @returns @true on success. This should be tested (as in the sample - shown above). + @return @true on success. This should be tested (as in the sample + shown above). */ bool Open(); diff --git a/interface/clrpicker.h b/interface/clrpicker.h index 908e953a7b..062c134d13 100644 --- a/interface/clrpicker.h +++ b/interface/clrpicker.h @@ -78,8 +78,8 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if - creation failed. + @return @true if the control was successfully created or @false if + creation failed. */ bool Create(wxWindow* parent, wxWindowID id, const wxColour& colour = wxBLACK, diff --git a/interface/cmdproc.h b/interface/cmdproc.h index 76c0577b07..a0bd1d0a2f 100644 --- a/interface/cmdproc.h +++ b/interface/cmdproc.h @@ -52,10 +52,10 @@ public: Override this member function to execute the appropriate action when called. - @returns @true to indicate that the action has taken place, @false - otherwise. Returning @false will indicate to the command - processor that the action is not undoable and should not be - added to the command history. + @return @true to indicate that the action has taken place, @false + otherwise. Returning @false will indicate to the command + processor that the action is not undoable and should not be + added to the command history. */ bool Do(); @@ -81,10 +81,10 @@ public: execute" operation is hard to write. The docview sample uses the first method, to remove or restore segments in the drawing. - @returns @true to indicate that the action has taken place, @false - otherwise. Returning @false will indicate to the command - processor that the action is not redoable and no change should - be made to the command history. + @return @true to indicate that the action has taken place, @false + otherwise. Returning @false will indicate to the command + processor that the action is not redoable and no change should + be made to the command history. */ bool Undo(); }; diff --git a/interface/collpane.h b/interface/collpane.h index aee05b57dc..161eff344d 100644 --- a/interface/collpane.h +++ b/interface/collpane.h @@ -136,8 +136,8 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if - creation failed. + @return @true if the control was successfully created or @false if + creation failed. */ bool Create(wxWindow* parent, wxWindowID id, const wxString& label, diff --git a/interface/combo.h b/interface/combo.h index 95259d4237..353daaf8f5 100644 --- a/interface/combo.h +++ b/interface/combo.h @@ -33,7 +33,7 @@ public: /** The derived class must implement this to create the popup control. - @returns @true if the call succeeded, @false otherwise. + @return @true if the call succeeded, @false otherwise. */ virtual bool Create(wxWindow* parent); @@ -359,9 +359,9 @@ public: The parameters are the same as those for DoShowPopup(). - @returns @true if animation finishes before the function returns, - @false otherwise. In the latter case you need to manually call - DoShowPopup() after the animation ends. + @return @true if animation finishes before the function returns, + @false otherwise. In the latter case you need to manually call + DoShowPopup() after the animation ends. */ virtual bool AnimateShow(const wxRect& rect, int flags); @@ -430,7 +430,7 @@ public: Returns disabled button bitmap that has been set with SetButtonBitmaps(). - @returns A reference to the disabled state bitmap. + @return A reference to the disabled state bitmap. */ const wxBitmap GetBitmapDisabled() const; @@ -438,7 +438,7 @@ public: Returns button mouse hover bitmap that has been set with SetButtonBitmaps(). - @returns A reference to the mouse hover state bitmap. + @return A reference to the mouse hover state bitmap. */ const wxBitmap GetBitmapHover() const; @@ -446,7 +446,7 @@ public: Returns default button bitmap that has been set with SetButtonBitmaps(). - @returns A reference to the normal state bitmap. + @return A reference to the normal state bitmap. */ const wxBitmap GetBitmapNormal() const; @@ -454,7 +454,7 @@ public: Returns depressed button bitmap that has been set with SetButtonBitmaps(). - @returns A reference to the depressed state bitmap. + @return A reference to the depressed state bitmap. */ const wxBitmap GetBitmapPressed() const; @@ -475,8 +475,8 @@ public: missing, you need to instead use wxGenericComboCtrl, which however may lack a native look and feel (but otherwise sports identical API). - @returns Value returned is a combination of the flags defined in - wxComboCtrlFeatures. + @return Value returned is a combination of the flags defined in + wxComboCtrlFeatures. */ static int GetFeatures(); diff --git a/interface/config.h b/interface/config.h index e1872573ac..fe056247c8 100644 --- a/interface/config.h +++ b/interface/config.h @@ -437,7 +437,7 @@ public: //@{ /** - @returns @true if either a group or an entry with a given name exists. + @return @true if either a group or an entry with a given name exists. */ bool Exists(wxString& strName) const; @@ -451,12 +451,12 @@ public: wxConfigBase::EntryType GetEntryType(const wxString& name) const; /** - @returns @true if the entry by this name exists. + @return @true if the entry by this name exists. */ bool HasEntry(wxString& strName) const; /** - @returns @true if the group by this name exists. + @return @true if the group by this name exists. */ bool HasGroup(const wxString& strName) const; @@ -503,7 +503,7 @@ public: Read a string from the key. The default value is returned if the key was not found. - @returns @true if value was really read, @false if the default was used. + @return @true if value was really read, @false if the default was used. */ const bool Read(const wxString& key, wxString* str, const wxString& defaultVal) const; @@ -637,8 +637,8 @@ public: and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function. - @returns @false if @a oldName doesn't exist or if @a newName already - exists. + @return @false if @a oldName doesn't exist or if @a newName already + exists. */ bool RenameEntry(const wxString& oldName, const wxString& newName); @@ -647,8 +647,8 @@ public: old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function. - @returns @false if @a oldName doesn't exist or if @a newName already - exists. + @return @false if @a oldName doesn't exist or if @a newName already + exists. */ bool RenameGroup(const wxString& oldName, const wxString& newName); diff --git a/interface/cshelp.h b/interface/cshelp.h index 258817b2b5..e727f54a71 100644 --- a/interface/cshelp.h +++ b/interface/cshelp.h @@ -107,8 +107,8 @@ public: @param origin Help event origin, see wxHelpEvent::GetOrigin. - @returns @true if help was shown, or @false if no help was available - for this window. + @return @true if help was shown, or @false if no help was available + for this window. @since 2.7.0 */ diff --git a/interface/ctrlsub.h b/interface/ctrlsub.h index bbfc670ac3..f540761470 100644 --- a/interface/ctrlsub.h +++ b/interface/ctrlsub.h @@ -56,8 +56,8 @@ public: @param n The zero-based index. - @returns The label of the item or an empty string if the position was - invalid. + @return The label of the item or an empty string if the position was + invalid. */ virtual wxString GetString(unsigned int n) const; @@ -84,8 +84,8 @@ public: @param caseSensitive Whether search is case sensitive (default is not). - @returns The zero-based position of the item, or wxNOT_FOUND if the - string was not found. + @return The zero-based position of the item, or wxNOT_FOUND if the + string was not found. */ virtual int FindString(const wxString& s, bool bCase = false) const; @@ -113,7 +113,7 @@ public: Returns the index of the selected item or @c wxNOT_FOUND if no item is selected. - @returns The position of the current selection. + @return The position of the current selection. @remarks This method can be used with single selection list boxes only, you should use wxListBox::GetSelections() for the list @@ -130,8 +130,8 @@ public: @param string The string to select. - @returns @true if the specified string has been selected, @false if it - wasn't found in the control. + @return @true if the specified string has been selected, @false if it + wasn't found in the control. */ bool SetStringSelection(const wxString& string); @@ -203,10 +203,10 @@ public: @param item String to add. - @returns The return value is the index of the newly inserted item. - Note that this may be different from the last one if the - control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT - style). + @return The return value is the index of the newly inserted item. + Note that this may be different from the last one if the + control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT + style). */ int Append(const wxString& item); @@ -218,10 +218,10 @@ public: @param clientData Pointer to client data to associate with the new item. - @returns The return value is the index of the newly inserted item. - Note that this may be different from the last one if the - control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT - style). + @return The return value is the index of the newly inserted item. + Note that this may be different from the last one if the + control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT + style). */ int Append(const wxString& item, void* clientData); @@ -233,10 +233,10 @@ public: @param clientData Pointer to client data to associate with the new item. - @returns The return value is the index of the newly inserted item. - Note that this may be different from the last one if the - control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT - style). + @return The return value is the index of the newly inserted item. + Note that this may be different from the last one if the + control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT + style). */ int Append(const wxString& item, wxClientData* clientData); @@ -361,7 +361,7 @@ public: @param n The zero-based position of the item. - @returns A pointer to the client data, or @NULL if not present. + @return A pointer to the client data, or @NULL if not present. */ void* GetClientData(unsigned int n) const; @@ -375,7 +375,7 @@ public: @param n The zero-based position of the item. - @returns A pointer to the client data, or @NULL if not present. + @return A pointer to the client data, or @NULL if not present. */ wxClientData* GetClientObject(unsigned int n) const; @@ -418,8 +418,8 @@ public: @param pos Position to insert item before, zero based. - @returns The return value is the index of the newly inserted item. - If the insertion failed for some reason, -1 is returned. + @return The return value is the index of the newly inserted item. + If the insertion failed for some reason, -1 is returned. */ int Insert(const wxString& item, unsigned int pos); @@ -433,8 +433,8 @@ public: @param clientData Pointer to client data to associate with the new item. - @returns The return value is the index of the newly inserted item. - If the insertion failed for some reason, -1 is returned. + @return The return value is the index of the newly inserted item. + If the insertion failed for some reason, -1 is returned. */ int Insert(const wxString& item, unsigned int pos, void* clientData); @@ -448,8 +448,8 @@ public: @param clientData Pointer to client data to associate with the new item. - @returns The return value is the index of the newly inserted item. - If the insertion failed for some reason, -1 is returned. + @return The return value is the index of the newly inserted item. + If the insertion failed for some reason, -1 is returned. */ int Insert(const wxString& item, unsigned int pos, wxClientData* clientData); diff --git a/interface/dataobj.h b/interface/dataobj.h index 467a78a419..fd5035b5ee 100644 --- a/interface/dataobj.h +++ b/interface/dataobj.h @@ -587,7 +587,7 @@ public: Set the data in the format @a format of the length @a len provided in the buffer @a buf. - @returns @true on success, @false on failure. + @return @true on success, @false on failure. */ virtual bool SetData(const wxDataFormat& format, size_t len, const void buf); diff --git a/interface/datectrl.h b/interface/datectrl.h index c2c1010f94..d32451ce57 100644 --- a/interface/datectrl.h +++ b/interface/datectrl.h @@ -89,7 +89,7 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if + @return @true if the control was successfully created or @false if creation failed. */ bool Create(wxWindow* parent, wxWindowID id, @@ -113,7 +113,7 @@ public: @param dt2 Same as above but for the upper limit. - @returns @false if no range limits are currently set, @true if at least + @return @false if no range limits are currently set, @true if at least one bound is set. */ bool GetRange(wxDateTime* dt1, wxDateTime dt2) const; diff --git a/interface/datetime.h b/interface/datetime.h index d964e6e599..b76b7b7025 100644 --- a/interface/datetime.h +++ b/interface/datetime.h @@ -761,7 +761,7 @@ public: be specified. It is thus less flexible then ParseDateTime(), but also has less chances to misinterpret the user input. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseDate(const wxString& date, @@ -771,7 +771,7 @@ public: be specified. It is thus less flexible then ParseDateTime(), but also has less chances to misinterpret the user input. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseDate(const char* date); @@ -780,7 +780,7 @@ public: be specified. It is thus less flexible then ParseDateTime(), but also has less chances to misinterpret the user input. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const wchar_t* ParseDate(const wchar_t* date); @@ -792,7 +792,7 @@ public: anything that may be accepted and will only reject strings which can not be parsed in any way at all. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseDateTime(const wxString& datetime, @@ -804,7 +804,7 @@ public: anything that may be accepted and will only reject strings which can not be parsed in any way at all. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseDateTime(const char* datetime); @@ -815,7 +815,7 @@ public: anything that may be accepted and will only reject strings which can not be parsed in any way at all. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const wchar_t* ParseDateTime(const wchar_t* datetime); @@ -839,7 +839,7 @@ public: @a dateDef. If it is not specified, Today() is used as the default date. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseFormat(const wxString& date, @@ -865,7 +865,7 @@ public: @a dateDef. If it is not specified, Today() is used as the default date. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseFormat(const char* date, @@ -890,7 +890,7 @@ public: @a dateDef. If it is not specified, Today() is used as the default date. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const wchar_t* ParseFormat(const wchar_t* date, @@ -903,7 +903,7 @@ public: the date and time parts must be equal to @a sep for the function to succeed. - @returns @true if the entire string was parsed successfully, @false + @return @true if the entire string was parsed successfully, @false otherwise. */ bool ParseISOCombined(const wxString& date, char sep = 'T'); @@ -911,7 +911,7 @@ public: /** This function parses the date in ISO 8601 format @c "YYYY-MM-DD". - @returns @true if the entire string was parsed successfully, @false + @return @true if the entire string was parsed successfully, @false otherwise. */ bool ParseISODate(const wxString& date); @@ -919,7 +919,7 @@ public: /** This function parses the time in ISO 8601 format @c "HH:MM:SS". - @returns @true if the entire string was parsed successfully, @false + @return @true if the entire string was parsed successfully, @false otherwise. */ bool ParseISOTime(const wxString& date); @@ -987,7 +987,7 @@ public: This functions is like ParseDateTime(), but only allows the time to be specified in the input string. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseTime(const wxString& time, @@ -996,7 +996,7 @@ public: This functions is like ParseDateTime(), but only allows the time to be specified in the input string. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const char* ParseTime(const char* time); @@ -1004,7 +1004,7 @@ public: This functions is like ParseDateTime(), but only allows the time to be specified in the input string. - @returns @NULL if the conversion failed, otherwise return the pointer + @return @NULL if the conversion failed, otherwise return the pointer to the character which stopped the scan. */ const wchar_t* ParseTime(const wchar_t* time); @@ -1074,7 +1074,7 @@ public: Sets the date to the last day in the specified month (the current one by default). - @returns The reference to the modified object itself. + @return The reference to the modified object itself. */ wxDateTime SetToLastMonthDay(Month month = Inv_Month, int year = Inv_Year); @@ -1092,7 +1092,7 @@ public: Sets the date so that it will be the first @a weekday following the current date. - @returns The reference to the modified object itself. + @return The reference to the modified object itself. */ wxDateTime& SetToNextWeekDay(WeekDay weekday); @@ -1100,7 +1100,7 @@ public: Sets the date so that it will be the last @a weekday before the current date. - @returns The reference to the modified object itself. + @return The reference to the modified object itself. */ wxDateTime& SetToPrevWeekDay(WeekDay weekday); @@ -1115,7 +1115,7 @@ public: SetToWeekDay(-1, wxDateTime::Sun) will set the date to the last Sunday in the current month. - @returns @true if the date was modified successfully, @false otherwise + @return @true if the date was modified successfully, @false otherwise meaning that the specified date doesn't exist. */ bool SetToWeekDay(WeekDay weekday, int n = 1, @@ -1125,7 +1125,7 @@ public: Adjusts the date so that it will still lie in the same week as before, but its week day will be the given one. - @returns The reference to the modified object itself. + @return The reference to the modified object itself. */ wxDateTime SetToWeekDayInSameWeek(WeekDay weekday, WeekFlags flags = Monday_First); @@ -1136,7 +1136,7 @@ public: number should be in the range 1-366 for the leap years and 1-365 for the other ones. - @returns The reference to the modified object itself. + @return The reference to the modified object itself. */ wxDateTime& SetToYearDay(wxDateTime_t yday); @@ -1209,7 +1209,7 @@ public: Transform the date from the given time zone to the local one. If @a noDST is @true, no DST adjustments will be made. - @returns The date in the local time zone. + @return The date in the local time zone. */ wxDateTime FromTimezone(const TimeZone& tz, bool noDST = false) const; @@ -1240,7 +1240,7 @@ public: Transform the date to the given time zone. If @a noDST is @true, no DST adjustments will be made. - @returns The date in the new time zone. + @return The date in the new time zone. */ wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const; @@ -1542,7 +1542,7 @@ public: /** Returns the sum of two date spans. - @returns A new wxDateSpan object with the result. + @return A new wxDateSpan object with the result. */ wxDateSpan Add(const wxDateSpan& other) const; /** @@ -1618,14 +1618,14 @@ public: product is computed by multiplying each of the components by the @a factor. - @returns A new wxDateSpan object with the result. + @return A new wxDateSpan object with the result. */ wxDateSpan Multiply(int factor) const; /** Multiplies this date span by the specified @a factor. The product is computed by multiplying each of the components by the @a factor. - @returns A reference to this wxDateSpan object modified in place. + @return A reference to this wxDateSpan object modified in place. */ wxDateSpan& Multiply(int factor); @@ -1670,7 +1670,7 @@ public: /** Returns the difference of two date spans. - @returns A new wxDateSpan object with the result. + @return A new wxDateSpan object with the result. */ wxDateSpan Subtract(const wxDateSpan& other) const; /** @@ -1729,7 +1729,7 @@ public: Multiplies this date span by the specified @a factor. The product is computed by multiplying each of the components by the @a factor. - @returns A reference to this wxDateSpan object modified in place. + @return A reference to this wxDateSpan object modified in place. */ wxDateSpan& operator*=(int factor); @@ -1782,7 +1782,7 @@ public: /** Returns the sum of two time spans. - @returns A new wxDateSpan object with the result. + @return A new wxDateSpan object with the result. */ wxTimeSpan Add(const wxTimeSpan& diff) const; /** @@ -1931,13 +1931,13 @@ public: /** Returns the product of this time span by @a n. - @returns A new wxTimeSpan object with the result. + @return A new wxTimeSpan object with the result. */ wxTimeSpan Multiply(int n) const; /** Multiplies this time span by @a n. - @returns A reference to this wxTimeSpan object modified in place. + @return A reference to this wxTimeSpan object modified in place. */ wxTimeSpan& Multiply(int n); @@ -1968,7 +1968,7 @@ public: /** Returns the difference of two time spans. - @returns A new wxDateSpan object with the result. + @return A new wxDateSpan object with the result. */ wxTimeSpan Subtract(const wxTimeSpan& diff) const; /** @@ -1995,7 +1995,7 @@ public: /** Multiplies this time span by @a n. - @returns A reference to this wxTimeSpan object modified in place. + @return A reference to this wxTimeSpan object modified in place. */ wxTimeSpan& operator*=(int n); diff --git a/interface/dc.h b/interface/dc.h index 18110e3709..9a3b4dac48 100644 --- a/interface/dc.h +++ b/interface/dc.h @@ -468,7 +468,7 @@ public: - wxFLOOD_BORDER: The area to be flooded is bounded by the given colour. - @returns @false if the operation failed. + @return @false if the operation failed. @note The present implementation for non-Windows platforms may fail to find colour borders if the pixels do not match the colour @@ -581,7 +581,7 @@ public: @a string is the text string to measure, @e heightLine, if non @NULL, is where to store the height of a single line. - @returns The text extent as a wxSize object. + @return The text extent as a wxSize object. @note This function works with both single-line and multi-line strings. diff --git a/interface/dde.h b/interface/dde.h index fd5542d761..66b979df74 100644 --- a/interface/dde.h +++ b/interface/dde.h @@ -68,7 +68,7 @@ public: the data associated with the given item. Causes the client connection's OnAdvise() member to be called. - @returns @true if successful. + @return @true if successful. */ bool Advise(const wxString& item, const void* data, size_t size, wxIPCFormat format = wxIPC_PRIVATE); @@ -85,7 +85,7 @@ public: calling application must explicitly delete its side of the connection having called Disconnect(). - @returns @true if successful. + @return @true if successful. */ bool Disconnect(); @@ -96,7 +96,7 @@ public: Poke() in that respect). Causes the server connection's OnExecute() member to be called. - @returns @true if successful. + @return @true if successful. */ bool Execute(const void* data, size_t size, wxIPCFormat format = wxIPC_PRIVATE); @@ -164,7 +164,7 @@ public: used to transfer arbitrary data to the server. Causes the server connection's OnPoke() member to be called. - @returns @true if successful. + @return @true if successful. */ bool Poke(const wxString& item, const void* data, size_t size, wxIPCFormat format = wxIPC_PRIVATE); @@ -177,7 +177,7 @@ public: Called by the client application to request data from the server. Causes the server connection's OnRequest() member to be called. - @returns A character string (actually a pointer to the connection's + @return A character string (actually a pointer to the connection's buffer) if successful, @NULL otherwise. */ const void* Request(const wxString& item, size_t* size, @@ -188,7 +188,7 @@ public: started with the server. Causes the server connection's OnStartAdvise() member to be called. - @returns @true if the server okays it, @false otherwise. + @return @true if the server okays it, @false otherwise. */ bool StartAdvise(const wxString& item); @@ -197,7 +197,7 @@ public: stopped. Causes the server connection's OnStopAdvise() member to be called. - @returns @true if the server okays it, @false otherwise. + @return @true if the server okays it, @false otherwise. */ bool StopAdvise(const wxString& item); }; diff --git a/interface/debugrpt.h b/interface/debugrpt.h index 27484774f2..bb40cb1997 100644 --- a/interface/debugrpt.h +++ b/interface/debugrpt.h @@ -41,7 +41,7 @@ public: Present the report to the user and allow him to modify it by removing some or all of the files and, potentially, adding some notes. - @returns @true if the report should be processed or @false if the user + @return @true if the report should be processed or @false if the user chose to cancel report generation or removed all files from it. */ @@ -198,7 +198,7 @@ public: the given @a name and writes @a text to it, then adds the file to the report. The @a filename shouldn't contain the path. - @returns @true if file could be added successfully, @false if an IO + @return @true if file could be added successfully, @false if an IO error occurred. */ bool AddText(const wxString& filename, const wxString& text, @@ -232,7 +232,7 @@ public: This method should be used to construct the full name of the files which you wish to add to the report using AddFile(). - @returns The name of the temporary directory used for the files in this + @return The name of the temporary directory used for the files in this report. */ const wxString GetDirectory() const; diff --git a/interface/dialog.h b/interface/dialog.h index c97cef8d89..431edf62b7 100644 --- a/interface/dialog.h +++ b/interface/dialog.h @@ -556,7 +556,7 @@ public: Shows a modal dialog. Program flow does not return until the dialog has been dismissed with EndModal(). - @returns The value set with SetReturnCode(). + @return The value set with SetReturnCode(). @see EndModal(), GetReturnCode(), SetReturnCode() */ diff --git a/interface/dialup.h b/interface/dialup.h index 165bf57581..849d21cbbd 100644 --- a/interface/dialup.h +++ b/interface/dialup.h @@ -101,7 +101,7 @@ public: by the system and so we don't do any polling and this parameter is ignored. - @returns @false if couldn't set up automatic check for online status. + @return @false if couldn't set up automatic check for online status. */ bool EnableAutoCheckOnlineStatus(size_t nSeconds = 60); diff --git a/interface/dnd.h b/interface/dnd.h index b82f304cdc..a6d5890f2d 100644 --- a/interface/dnd.h +++ b/interface/dnd.h @@ -121,7 +121,7 @@ public: Suggested value for return value. Determined by SHIFT or CONTROL key states. - @returns The desired operation or wxDragNone. This is used for optical + @return The desired operation or wxDragNone. This is used for optical feedback from the side of the drop source, typically in form of changing the icon. */ @@ -136,7 +136,7 @@ public: @param y The y coordinate of the mouse. - @returns @true to accept the data, or @false to veto the operation. + @return @true to accept the data, or @false to veto the operation. */ virtual bool OnDrop(wxCoord x, wxCoord y); @@ -152,7 +152,7 @@ public: Suggested default for return value. Determined by SHIFT or CONTROL key states. - @returns The desired operation or wxDragNone. This is used for optical + @return The desired operation or wxDragNone. This is used for optical feedback from the side of the drop source, typically in form of changing the icon. */ @@ -244,7 +244,7 @@ public: (which includes the previous flag), this is even the default operation. - @returns The operation requested by the user, may be ::wxDragCopy, + @return The operation requested by the user, may be ::wxDragCopy, ::wxDragMove, ::wxDragLink, ::wxDragCancel or ::wxDragNone if an error occurred. */ @@ -266,7 +266,7 @@ public: @param scrolling @true if the window is scrolling. MSW only. - @returns @false if you want default feedback, or @true if you implement + @return @false if you want default feedback, or @true if you implement your own feedback. The return values is ignored under GTK. */ virtual bool GiveFeedback(wxDragResult effect); @@ -349,7 +349,7 @@ public: This macro should be used with wxDropSource::wxDropSource(). - @returns wxCursor on MSW, otherwise returns a wxIcon + @return wxCursor on MSW, otherwise returns a wxIcon @header{wx/dnd.h} */ diff --git a/interface/dynlib.h b/interface/dynlib.h index 989cc9dd95..3392ef4f19 100644 --- a/interface/dynlib.h +++ b/interface/dynlib.h @@ -32,7 +32,7 @@ public: Pointer to the location to return the size of this module in memory in, may be @NULL. - @returns @true if the load address and module size were retrieved, + @return @true if the load address and module size were retrieved, @false if this information is not available. */ bool GetAddress(void** addr, size_t len) const; diff --git a/interface/event.h b/interface/event.h index 4527139b10..125bff5a09 100644 --- a/interface/event.h +++ b/interface/event.h @@ -528,7 +528,7 @@ public: @param event Event to process. - @returns @true if a suitable event handler function was found and + @return @true if a suitable event handler function was found and executed, and the function did not call wxEvent::Skip. @see SearchEventTable() @@ -543,7 +543,7 @@ public: @param event Event to process. - @returns @true if the event was processed, @false if no handler was found + @return @true if the event was processed, @false if no handler was found or an exception was thrown. @see wxWindow::HandleWindowEvent @@ -559,7 +559,7 @@ public: @param event Event to be matched against an event table entry. - @returns @true if a suitable event handler function was found and + @return @true if a suitable event handler function was found and executed, and the function did not call wxEvent::Skip. @remarks This function looks through the object's event table and tries diff --git a/interface/ffile.h b/interface/ffile.h index da0722860e..a19619ff9a 100644 --- a/interface/ffile.h +++ b/interface/ffile.h @@ -177,7 +177,7 @@ public: @param count The number of bytes to read. - @returns The number of bytes read. + @return The number of bytes read. */ size_t Read(void* buffer, size_t count); @@ -190,7 +190,7 @@ public: Conversion object to use in Unicode build; by default supposes that file contents is encoded in UTF-8. - @returns @true if file was read successfully, @false otherwise. + @return @true if file was read successfully, @false otherwise. */ bool ReadAll(wxString* str, const wxMBConv& conv = wxConvAuto()); @@ -234,7 +234,7 @@ public: @param count The number of bytes to write. - @returns The number of bytes written. + @return The number of bytes written. */ size_t Write(const void* buffer, size_t count); diff --git a/interface/file.h b/interface/file.h index 7ece7ce26e..cb74e2dfa8 100644 --- a/interface/file.h +++ b/interface/file.h @@ -281,7 +281,7 @@ public: @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - @returns The actual offset position achieved, or wxInvalidOffset on + @return The actual offset position achieved, or wxInvalidOffset on failure. */ wxFileOffset Seek(wxFileOffset ofs, @@ -295,7 +295,7 @@ public: @param ofs Number of bytes before the end of the file. - @returns The actual offset position achieved, or wxInvalidOffset on + @return The actual offset position achieved, or wxInvalidOffset on failure. */ wxFileOffset SeekEnd(wxFileOffset ofs = 0); diff --git a/interface/filectrl.h b/interface/filectrl.h index ff54bb3bef..dfbc382192 100644 --- a/interface/filectrl.h +++ b/interface/filectrl.h @@ -78,7 +78,7 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if + @return @true if the control was successfully created or @false if creation failed. */ @@ -154,14 +154,14 @@ public: /** Sets(changes) the current directory displayed in the control. - @returns Returns @true on success, @false otherwise. + @return Returns @true on success, @false otherwise. */ bool SetDirectory(const wxString& directory); /** Selects a certain file. - @returns Returns @true on success, @false otherwise + @return Returns @true on success, @false otherwise */ bool SetFilename(const wxString& filename); diff --git a/interface/filefn.h b/interface/filefn.h index 152319c98d..533ee9b5a4 100644 --- a/interface/filefn.h +++ b/interface/filefn.h @@ -124,7 +124,7 @@ public: @note The generic Unix implementation depends on the system having the @c statfs() or @c statvfs() function. - @returns @true on success, @false if an error occurred (for example, the + @return @true on success, @false if an error occurred (for example, the directory doesn’t exist). @header{wx/filefn.h} diff --git a/interface/filename.h b/interface/filename.h index 54c02a8c78..429cee3a8b 100644 --- a/interface/filename.h +++ b/interface/filename.h @@ -178,7 +178,7 @@ public: @param fileTemp The file to open or @NULL to just get the name - @returns The full temporary file name or an empty string on error. + @return The full temporary file name or an empty string on error. */ static wxString CreateTempFileName(const wxString& prefix, wxFile* fileTemp = NULL); @@ -333,7 +333,7 @@ public: the volume is empty, the program's current working directory is returned for the current volume. - @returns The string containing the current working directory or an empty + @return The string containing the current working directory or an empty string on error. @see AssignCwd() @@ -511,7 +511,7 @@ public: Any of the pointers may be @NULL if the corresponding time is not needed. - @returns @true on success, @false if we failed to retrieve the times. + @return @true on success, @false if we failed to retrieve the times. */ bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod, wxDateTime* dtCreate) const; @@ -681,7 +681,7 @@ public: @param format the file name format, native by default - @returns @true if the file name has been changed, @false if we failed to do + @return @true if the file name has been changed, @false if we failed to do anything with it (currently this only happens if the file name is on a volume different from the volume specified by pathBase). @@ -702,7 +702,7 @@ public: try to create each directory in the path and also don't return an error if the target directory already exists. - @returns Returns @true if the directory was successfully created, @false + @return Returns @true if the directory was successfully created, @false otherwise. */ bool Mkdir(int perm = 0777, int flags = 0); @@ -814,7 +814,7 @@ public: @param format The file name format to use when processing the paths, native by default. - @returns @true if normalization was successfully or @false otherwise. + @return @true if normalization was successfully or @false otherwise. */ bool Normalize(int flags = wxPATH_NORM_ALL, const wxString& cwd = wxEmptyString, diff --git a/interface/filepicker.h b/interface/filepicker.h index 480c701847..2cb91adc97 100644 --- a/interface/filepicker.h +++ b/interface/filepicker.h @@ -88,7 +88,7 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if + @return @true if the control was successfully created or @false if creation failed. */ bool Create(wxWindow* parent, wxWindowID id, @@ -202,7 +202,7 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if + @return @true if the control was successfully created or @false if creation failed. */ bool Create(wxWindow* parent, wxWindowID id, diff --git a/interface/fontpicker.h b/interface/fontpicker.h index c4e0343854..15c540785a 100644 --- a/interface/fontpicker.h +++ b/interface/fontpicker.h @@ -76,7 +76,7 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if + @return @true if the control was successfully created or @false if creation failed. */ bool Create(wxWindow* parent, wxWindowID id, diff --git a/interface/frame.h b/interface/frame.h index 9235115df7..51af4a1666 100644 --- a/interface/frame.h +++ b/interface/frame.h @@ -196,7 +196,7 @@ public: @param name The status bar window name. - @returns A pointer to the status bar if it was created successfully, @NULL + @return A pointer to the status bar if it was created successfully, @NULL otherwise. @remarks The width of the status bar is the whole width of the frame @@ -222,7 +222,7 @@ public: @param name The toolbar window name. - @returns A pointer to the toolbar if it was created successfully, @NULL + @return A pointer to the toolbar if it was created successfully, @NULL otherwise. @remarks By default, the toolbar is an instance of wxToolBar (which is @@ -286,7 +286,7 @@ public: @param name The window name. - @returns A status bar object. + @return A status bar object. @remarks An application can override this function to return a different kind of status bar. The default implementation returns @@ -310,7 +310,7 @@ public: @param name The toolbar window name. - @returns A toolbar object. + @return A toolbar object. @remarks An application can override this function to return a different kind of toolbar. The default implementation returns an diff --git a/interface/gbsizer.h b/interface/gbsizer.h index 5dc8787188..30ffb83eab 100644 --- a/interface/gbsizer.h +++ b/interface/gbsizer.h @@ -86,7 +86,7 @@ public: /** Adds the given item to the given position. - @returns A valid pointer if the item was successfully placed at the + @return A valid pointer if the item was successfully placed at the given position, or @NULL if something was already there. */ wxSizerItem* Add(wxWindow* window, const wxGBPosition& pos, diff --git a/interface/gdicmn.h b/interface/gdicmn.h index aeafd9d5f0..f415ecf9d8 100644 --- a/interface/gdicmn.h +++ b/interface/gdicmn.h @@ -723,7 +723,7 @@ public: to scale both dimensions by the same factor you can also use operator*=(). - @returns A reference to this object (so that you can concatenate other + @return A reference to this object (so that you can concatenate other operations in the same line). */ wxSize& Scale(float xscale, float yscale); diff --git a/interface/html/htmlcell.h b/interface/html/htmlcell.h index bd81c7f5d9..79c441f684 100644 --- a/interface/html/htmlcell.h +++ b/interface/html/htmlcell.h @@ -277,7 +277,7 @@ public: @param event mouse event that triggered the call - @returns @true if a link was clicked, @false otherwise. + @return @true if a link was clicked, @false otherwise. */ virtual bool ProcessMouseClick(wxHtmlWindowInterface* window, const wxPoint& pos, diff --git a/interface/html/htmlpars.h b/interface/html/htmlpars.h index c11115af3a..1131d385b3 100644 --- a/interface/html/htmlpars.h +++ b/interface/html/htmlpars.h @@ -35,7 +35,7 @@ public: one of supported tags is detected. @a tag contains all necessary info (see wxHtmlTag for details). - @returns @true if ParseInner was called, @false otherwise. + @return @true if ParseInner was called, @false otherwise. */ virtual bool HandleTag(const wxHtmlTag& tag); diff --git a/interface/html/htmlwin.h b/interface/html/htmlwin.h index 4a4703f681..086eed1a28 100644 --- a/interface/html/htmlwin.h +++ b/interface/html/htmlwin.h @@ -72,7 +72,7 @@ public: @param source HTML code fragment - @returns @false if an error occurred, @true otherwise. + @return @false if an error occurred, @true otherwise. */ bool AppendToPage(const wxString& source); @@ -140,7 +140,7 @@ public: /** Loads HTML page from file and displays it. - @returns @false if an error occurred, @true otherwise + @return @false if an error occurred, @true otherwise @see LoadPage() */ @@ -154,7 +154,7 @@ public: The address of document. See wxFileSystem for details on address format and behaviour of "opener". - @returns @false if an error occurred, @true otherwise + @return @false if an error occurred, @true otherwise @see LoadFile() */ @@ -176,7 +176,7 @@ public: @param event The mouse event containing other information about the click - @returns @true if a link was clicked, @false otherwise. + @return @true if a link was clicked, @false otherwise. */ virtual bool OnCellClicked(wxHtmlCell cell, wxCoord x, wxCoord y, const wxMouseEvent& event); @@ -351,7 +351,7 @@ public: @param source The HTML document source to be displayed. - @returns @false if an error occurred, @true otherwise. + @return @false if an error occurred, @true otherwise. */ bool SetPage(const wxString& source); diff --git a/interface/icon.h b/interface/icon.h index 877215fa52..acfca50218 100644 --- a/interface/icon.h +++ b/interface/icon.h @@ -274,7 +274,7 @@ public: The validity of these flags depends on the platform and wxWidgets configuration. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @see wxIcon() */ diff --git a/interface/image.h b/interface/image.h index 74d814fde7..666139100d 100644 --- a/interface/image.h +++ b/interface/image.h @@ -25,6 +25,8 @@ @category{FIXME} @see wxImage, wxInitAllImageHandlers() + + @todo Document all image handler types, indicating their library. */ class wxImageHandler : public wxObject { @@ -54,7 +56,7 @@ public: Opened input stream for reading image data. Currently, the stream must support seeking. - @returns Number of available images. For most image handlers, this is 1 + @return Number of available images. For most image handlers, this is 1 (exceptions are TIFF and ICO formats). */ int GetImageCount(wxInputStream& stream); @@ -91,7 +93,7 @@ public: @param index The index of the image in the file (starting from zero). - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @see wxImage::LoadFile, wxImage::SaveFile, SaveFile() */ @@ -106,7 +108,7 @@ public: @param stream Opened output stream for writing the data. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @see wxImage::LoadFile, wxImage::SaveFile, LoadFile() */ @@ -359,7 +361,7 @@ public: wxImageHistogram object. wxImageHistogram is a specialization of wxHashMap "template" and is defined as follows: - @returns Returns number of colours in the histogram. + @return Returns number of colours in the histogram. */ unsigned long ComputeHistogram(wxImageHistogram& histogram) const; @@ -371,7 +373,7 @@ public: If the image image doesn't have alpha channel, ConvertAlphaToMask does nothing. - @returns @false if FindFirstUnusedColour returns @false, @true otherwise. + @return @false if FindFirstUnusedColour returns @false, @true otherwise. */ bool ConvertAlphaToMask(unsigned char threshold = 128); @@ -413,7 +415,7 @@ public: @param height The height of the image in pixels. - @returns @true if the call succeeded, @false otherwise. + @return @true if the call succeeded, @false otherwise. */ bool Create(int width, int height, bool clear = true); @@ -429,7 +431,7 @@ public: Initial values of the colour. Returned colour will have RGB values equal to or greater than these. - @returns Returns @false if there is no unused colour left, @true on success. + @return Returns @false if there is no unused colour left, @true on success. */ bool FindFirstUnusedColour(unsigned char* r, unsigned char* g, unsigned char* b, @@ -450,7 +452,7 @@ public: @param mimetype MIME type. - @returns A pointer to the handler if found, @NULL otherwise. + @return A pointer to the handler if found, @NULL otherwise. @see wxImageHandler */ @@ -536,7 +538,7 @@ public: @li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI). @li wxBITMAP_TYPE_ANY: Will try to autodetect the format. - @returns Number of available images. For most image handlers, this is 1 + @return Number of available images. For most image handlers, this is 1 (exceptions are TIFF and ICO formats). */ static int GetImageCount(const wxString& filename, @@ -550,7 +552,7 @@ public: file extension masks suitable for passing to file open/save dialog boxes. - @returns The format of the returned string is + @return The format of the returned string is "(*.ext1;*.ext2)|*.ext1;*.ext2". @see wxImageHandler @@ -739,7 +741,7 @@ public: interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler. - @returns @true if the operation succeeded, @false otherwise. If the + @return @true if the operation succeeded, @false otherwise. If the optional index parameter is out of range, @false is returned and a call to wxLogError() takes place. @@ -793,7 +795,7 @@ public: @param name The handler name. - @returns @true if the handler was found and removed, @false otherwise. + @return @true if the handler was found and removed, @false otherwise. @see wxImageHandler */ @@ -884,7 +886,7 @@ public: @param mimetype MIME type. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. @remarks Depending on how wxWidgets has been configured, not all formats may be available. @@ -980,7 +982,7 @@ public: @param mr,mg,mb RGB value of pixels in mask that will be used to create the mask. - @returns Returns @false if mask does not have same dimensions as the image + @return Returns @false if mask does not have same dimensions as the image or if there is no unused colour left. Returns @true if the mask was successfully applied. */ @@ -1039,7 +1041,7 @@ public: @param image Image to assign. - @returns Returns 'this' object. + @return Returns 'this' object. */ wxImage operator =(const wxImage& image); }; diff --git a/interface/imaglist.h b/interface/imaglist.h index ffa37adac7..ca3711c418 100644 --- a/interface/imaglist.h +++ b/interface/imaglist.h @@ -60,7 +60,7 @@ public: @param icon Icon to use as the image. - @returns The new zero-based image index. + @return The new zero-based image index. @remarks The original bitmap or icon is not affected by the Add operation, and can be deleted afterwards. @@ -169,7 +169,7 @@ public: @param height receives the height of the images in the list - @returns @true if the function succeeded, @false if it failed (for example, + @return @true if the function succeeded, @false if it failed (for example, if the image list was not yet initialized). */ bool GetSize(int index, int& width, int& height) const; @@ -195,7 +195,7 @@ public: @param icon Icon to use as the image. - @returns @true if the replacement was successful, @false otherwise. + @return @true if the replacement was successful, @false otherwise. @remarks The original bitmap or icon is not affected by the Replace operation, and can be deleted afterwards. diff --git a/interface/intl.h b/interface/intl.h index 3b77265194..e71e3ef00f 100644 --- a/interface/intl.h +++ b/interface/intl.h @@ -544,7 +544,7 @@ public: This macro is identical to _() but for the plural variant of wxGetTranslation(). - @returns A const wxString. + @return A const wxString. @header{wx/intl.h} */ @@ -587,7 +587,7 @@ public: would be no translations for the weekday names in the program message catalog and wxGetTranslation() wouldn't find them. - @returns A const wxChar*. + @return A const wxChar*. @header{wx/intl.h} */ diff --git a/interface/joystick.h b/interface/joystick.h index 69707ba76d..d9b739c6ff 100644 --- a/interface/joystick.h +++ b/interface/joystick.h @@ -240,7 +240,7 @@ public: /** Releases the capture set by @b SetCapture. - @returns @true if the capture release succeeded. + @return @true if the capture release succeeded. @see SetCapture(), wxJoystickEvent */ @@ -256,7 +256,7 @@ public: threshold. If greater than zero, events are received every pollingFreq milliseconds. - @returns @true if the capture succeeded. + @return @true if the capture succeeded. @see ReleaseCapture(), wxJoystickEvent */ diff --git a/interface/listbox.h b/interface/listbox.h index 8f5eb48ff0..15827bc417 100644 --- a/interface/listbox.h +++ b/interface/listbox.h @@ -150,7 +150,7 @@ public: A reference to an wxArrayInt instance that is used to store the result of the query. - @returns The number of selections. + @return The number of selections. @remarks Use this with a multiple selection listbox. @@ -168,7 +168,7 @@ public: @param point Point of item (in client coordinates) to obtain - @returns Item located at point, or wxNOT_FOUND if unimplemented or the + @return Item located at point, or wxNOT_FOUND if unimplemented or the item does not exist. @since 2.7.0 @@ -200,7 +200,7 @@ public: @param n The zero-based item index. - @returns @true if the given item is selected, @false otherwise. + @return @true if the given item is selected, @false otherwise. */ bool IsSelected(int n) const; diff --git a/interface/listctrl.h b/interface/listctrl.h index b750af1a55..31e28708a7 100644 --- a/interface/listctrl.h +++ b/interface/listctrl.h @@ -1149,7 +1149,7 @@ public: Together with GetNextSelected() it can be used to iterate over all selected items in the control. - @returns The first selected item, if any, -1 otherwise. + @return The first selected item, if any, -1 otherwise. */ long GetFirstSelected() const; @@ -1164,7 +1164,7 @@ public: Used together with GetFirstSelected() to iterate over all selected items in the control. - @returns Returns the next selected item or -1 if there are no more of + @return Returns the next selected item or -1 if there are no more of them. */ long GetNextSelected(long item) const; diff --git a/interface/memory.h b/interface/memory.h index 0ffb85394a..ec1fbed3de 100644 --- a/interface/memory.h +++ b/interface/memory.h @@ -54,7 +54,7 @@ public: Checks the memory blocks for errors, starting from the currently set checkpoint. - @returns Returns the number of errors, so a value of zero represents + @return Returns the number of errors, so a value of zero represents success. Returns -1 if an error was detected that prevents further checking. */ @@ -65,7 +65,7 @@ public: current debug stream. Calls the @b Dump member function for each wxObject derived instance. - @returns @true if the function succeeded, @false otherwise. + @return @true if the function succeeded, @false otherwise. */ bool Dump(); diff --git a/interface/menu.h b/interface/menu.h index febdab78e3..17cea85ad4 100644 --- a/interface/menu.h +++ b/interface/menu.h @@ -59,7 +59,7 @@ public: @param title The title of the menu. - @returns @true on success, @false if an error occurred. + @return @true on success, @false if an error occurred. @see Insert() */ @@ -111,7 +111,7 @@ public: @param menu If not @NULL, menu will get set to the associated menu. - @returns The found menu item object, or @NULL if one was not found. + @return The found menu item object, or @NULL if one was not found. */ wxMenuItem* FindItem(int id, wxMenu menu = NULL) const; @@ -131,7 +131,7 @@ public: @param itemString Item to find. - @returns The menu item identifier, or wxNOT_FOUND if none was found. + @return The menu item identifier, or wxNOT_FOUND if none was found. @remarks Any special menu codes are stripped out of source and target strings before matching. @@ -145,8 +145,8 @@ public: @param id The menu item identifier. - @returns The help string, or the empty string if there was no help string - or the menu item was not found. + @return The help string, or the empty string if there was no help string + or the menu item was not found. @see SetHelpString() */ @@ -158,8 +158,8 @@ public: @param id The menu item identifier. - @returns The menu item label, or the empty string if the item was not - found. + @return The menu item label, or the empty string if the item was not + found. @remarks Use only after the menubar has been associated with a frame. */ @@ -173,7 +173,7 @@ public: @param pos Position of the menu on the menu bar, starting from zero. - @returns The menu label, or the empty string if the menu was not found. + @return The menu label, or the empty string if the menu was not found. @remarks Use only after the menubar has been associated with a frame. @@ -199,7 +199,7 @@ public: @param pos Position of the menu on the menu bar, starting from zero. - @returns The menu label, or the empty string if the menu was not found. + @return The menu label, or the empty string if the menu was not found. @remarks Use only after the menubar has been associated with a frame. @@ -215,7 +215,7 @@ public: @param pos Position of the menu on the menu bar, starting from zero. - @returns The menu label, or the empty string if the menu was not found. + @return The menu label, or the empty string if the menu was not found. @remarks Use only after the menubar has been associated with a frame. @@ -236,7 +236,7 @@ public: @param title The title of the menu. - @returns @true on success, @false if an error occurred. + @return @true on success, @false if an error occurred. @see Append() */ @@ -248,7 +248,7 @@ public: @param id The menu item identifier. - @returns @true if the item was found and is checked, @false otherwise. + @return @true if the item was found and is checked, @false otherwise. */ bool IsChecked(int id) const; @@ -258,7 +258,7 @@ public: @param id The menu item identifier. - @returns @true if the item was found and is enabled, @false otherwise. + @return @true if the item was found and is enabled, @false otherwise. */ bool IsEnabled(int id) const; @@ -287,8 +287,8 @@ public: @param title The title of the menu. - @returns The menu which was previously at position pos. The caller is - responsible for deleting it. + @return The menu which was previously at position pos. The caller is + responsible for deleting it. @see Insert(), Remove() */ @@ -601,7 +601,7 @@ public: @param itemString Menu item string to find. - @returns Menu item identifier, or wxNOT_FOUND if none is found. + @return Menu item identifier, or wxNOT_FOUND if none is found. @remarks Any special menu codes are stripped out of source and target strings before matching. @@ -618,7 +618,7 @@ public: If the pointer is not @NULL, it will be filled with the item's parent menu (if the item was found) - @returns Menu item object or NULL if none is found. + @return Menu item object or NULL if none is found. */ const wxMenuItem * FindItem(int id, wxMenu** menu = NULL) const; @@ -633,8 +633,8 @@ public: @param id The menu item identifier. - @returns The help string, or the empty string if there is no help string - or the item was not found. + @return The help string, or the empty string if there is no help string + or the item was not found. @see SetHelpString(), Append() */ @@ -646,7 +646,7 @@ public: @param id The menu item identifier. - @returns The item label, or the empty string if the item was not found. + @return The item label, or the empty string if the item was not found. @see GetLabelText(), SetLabel() */ @@ -659,7 +659,7 @@ public: @param id The menu item identifier. - @returns The item label, or the empty string if the item was not found. + @return The item label, or the empty string if the item was not found. @see GetLabel(), SetLabel() */ @@ -738,7 +738,7 @@ public: @param id The menu item identifier. - @returns @true if the menu item is checked, @false otherwise. + @return @true if the menu item is checked, @false otherwise. @see Check() */ @@ -750,7 +750,7 @@ public: @param id The menu item identifier. - @returns @true if the menu item is enabled, @false otherwise. + @return @true if the menu item is enabled, @false otherwise. @see Enable() */ @@ -805,7 +805,7 @@ public: @param id The identifier of the menu item to remove. - @returns The item which was detached from the menu. + @return The item which was detached from the menu. */ wxMenuItem* Remove(int id); @@ -817,7 +817,7 @@ public: @param item The menu item to remove. - @returns The item which was detached from the menu. + @return The item which was detached from the menu. */ wxMenuItem* Remove(wxMenuItem* item); diff --git a/interface/msw/ole/automtn.h b/interface/msw/ole/automtn.h index 982efbe01a..e8fe35671b 100644 --- a/interface/msw/ole/automtn.h +++ b/interface/msw/ole/automtn.h @@ -156,7 +156,7 @@ public: @param ptrArgs If non-null, contains an array of constant pointers to variants. - @returns @true if the operation was successful, @false otherwise. + @return @true if the operation was successful, @false otherwise. @remarks Two types of argument array are provided, so that when possible pointers are used for efficiency. diff --git a/interface/notebook.h b/interface/notebook.h index c5c2c65e57..807e42c1db 100644 --- a/interface/notebook.h +++ b/interface/notebook.h @@ -162,7 +162,7 @@ public: @param imageId Specifies the optional image index for the new page. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks Do not delete the page, it will be deleted by the notebook. @@ -339,7 +339,7 @@ public: The point was over a currently selected page, not over any tab. Note that this flag is present only if wxNOT_FOUND is returned. - @returns Returns the zero-based tab index or wxNOT_FOUND if there is no + @return Returns the zero-based tab index or wxNOT_FOUND if there is no tab is at the specified position. */ virtual int HitTest(const wxPoint& pt, long* = NULL) const; @@ -358,7 +358,7 @@ public: @param imageId Specifies the optional image index for the new page. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks Do not delete the page, it will be deleted by the notebook. diff --git a/interface/object.h b/interface/object.h index e84f3a8266..ecfbbb93db 100644 --- a/interface/object.h +++ b/interface/object.h @@ -250,7 +250,7 @@ public: A pointer to a class information object, which may be obtained by using the ::CLASSINFO macro. - @returns @true if the class represented by info is the same class as this + @return @true if the class represented by info is the same class as this one or is derived from it. */ bool IsKindOf(wxClassInfo* info); @@ -368,7 +368,7 @@ public: /** Creates an object of the appropriate kind. - @returns @NULL if the class has not been declared dynamically creatable + @return @NULL if the class has not been declared dynamically creatable (typically, this happens for abstract classes). */ wxObject* CreateObject() const; diff --git a/interface/palette.h b/interface/palette.h index 28707a3a62..f1a9a4bdc0 100644 --- a/interface/palette.h +++ b/interface/palette.h @@ -86,7 +86,7 @@ public: @param blue An array of blue values. - @returns @true if the creation was successful, @false otherwise. + @return @true if the creation was successful, @false otherwise. @see wxPalette() */ @@ -109,7 +109,7 @@ public: @param blue Blue value. - @returns The nearest palette index or @c wxNOT_FOUND for unexpected errors. + @return The nearest palette index or @c wxNOT_FOUND for unexpected errors. @see GetRGB() */ @@ -128,7 +128,7 @@ public: @param blue Receives the blue value. - @returns @true if the operation was successful. + @return @true if the operation was successful. @see GetPixel() */ diff --git a/interface/process.h b/interface/process.h index 075b57845d..1401717d76 100644 --- a/interface/process.h +++ b/interface/process.h @@ -237,7 +237,7 @@ public: The flags to pass to ::wxExecute(). Note: @c wxEXEC_SYNC should not be used. - @returns A pointer to new wxProcess object or @NULL on error. + @return A pointer to new wxProcess object or @NULL on error. @see ::wxExecute() */ diff --git a/interface/protocol/ftp.h b/interface/protocol/ftp.h index 61ecaf18e9..a99c957787 100644 --- a/interface/protocol/ftp.h +++ b/interface/protocol/ftp.h @@ -116,7 +116,7 @@ public: Send the specified @a command to the FTP server. @a ret specifies the expected result. - @returns @true if the command has been sent successfully, else @false. + @return @true if the command has been sent successfully, else @false. */ bool CheckCommand(const wxString& command, char ret); @@ -173,7 +173,7 @@ public: This list always has the same format and contains one full (including the directory path) file name per line. - @returns @true if the file list was successfully retrieved, @false otherwise. + @return @true if the file list was successfully retrieved, @false otherwise. @see GetDirList() */ @@ -190,7 +190,7 @@ public: You will be notified when the EOF is reached by an error. - @returns Returns @NULL if an error occurred (it could be a network failure + @return Returns @NULL if an error occurred (it could be a network failure or the fact that the file doesn't exist). */ wxInputStream* GetInputStream(const wxString& path); @@ -206,7 +206,7 @@ public: The returned stream has all but the seek functionality of wxStreams. When the user finishes writing data, he has to delete the stream to close it. - @returns An initialized write-only stream. + @return An initialized write-only stream. @see wxOutputStream */ diff --git a/interface/protocol/http.h b/interface/protocol/http.h index 30e5c1e435..6cd1332ae8 100644 --- a/interface/protocol/http.h +++ b/interface/protocol/http.h @@ -43,7 +43,7 @@ public: In such case, you may want to use wxInputStream::LastRead() method in a loop to get the total size. - @returns Returns the initialized stream. You must delete it yourself + @return Returns the initialized stream. You must delete it yourself once you don't use it anymore and this must be done before the wxHTTP object itself is destroyed. The destructor closes the network connection. The next time you will diff --git a/interface/protocol/protocol.h b/interface/protocol/protocol.h index 185bdd58ce..af8d45e12e 100644 --- a/interface/protocol/protocol.h +++ b/interface/protocol/protocol.h @@ -44,7 +44,7 @@ public: It is advised to destroy the input stream instead of aborting the stream this way. - @returns Returns @true, if successful, else @false. + @return Returns @true, if successful, else @false. */ bool Abort(); @@ -69,7 +69,7 @@ public: available for the moment for this sort of stream. You will be notified when the EOF is reached by an error. - @returns Returns the initialized stream. You will have to delete it + @return Returns the initialized stream. You will have to delete it yourself once you don't use it anymore. The destructor closes the network connection. @@ -81,7 +81,7 @@ public: Tries to reestablish a previous opened connection (close and renegotiate connection). - @returns @true, if the connection is established, else @false. + @return @true, if the connection is established, else @false. */ bool Reconnect(); diff --git a/interface/region.h b/interface/region.h index a9f96cf2f5..eeae07060d 100644 --- a/interface/region.h +++ b/interface/region.h @@ -155,7 +155,7 @@ public: Returns a value indicating whether the given rectangle is contained within the region. - @returns The return value is one of wxOutRegion, wxPartRegion and + @return The return value is one of wxOutRegion, wxPartRegion and wxInRegion. */ wxRegionContain Contains(long& x, long& y) const; @@ -185,7 +185,7 @@ public: /** Finds the intersection of this region and another region. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this @@ -214,7 +214,7 @@ public: Moves the region by the specified offsets in horizontal and vertical directions. - @returns @true if successful, @false otherwise (the region is unchanged + @return @true if successful, @false otherwise (the region is unchanged then). */ bool Offset(wxCoord x, wxCoord y); @@ -225,7 +225,7 @@ public: /** Subtracts a region from this region. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this @@ -242,7 +242,7 @@ public: @a transColour argument, along with an optional colour tolerance value. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks This operation creates a region that combines all of this region and the second region. The result is stored in this @@ -260,7 +260,7 @@ public: /** Finds the Xor of this region and another region. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks This operation creates a region that combines all of this region and the second region, except for any overlapping diff --git a/interface/sizer.h b/interface/sizer.h index c208e9973e..73cd6bf479 100644 --- a/interface/sizer.h +++ b/interface/sizer.h @@ -585,7 +585,7 @@ public: Returns a wxOrientation value that specifies whether the sizer flexibly resizes its columns, rows, or both (default). - @returns One of the following values: + @return One of the following values: @see SetFlexibleDirection() */ @@ -595,7 +595,7 @@ public: Returns the value that specifies how the sizer grows in the "non-flexible" direction if there is one. - @returns One of the following values: + @return One of the following values: @see SetFlexibleDirection(), SetNonFlexibleGrowMode() diff --git a/interface/snglinst.h b/interface/snglinst.h index 42942a2a19..b24130c399 100644 --- a/interface/snglinst.h +++ b/interface/snglinst.h @@ -91,7 +91,7 @@ public: create the lock file in under Unix (default is wxGetHomeDir()) - @returns Returns @false if initialization failed, it doesn't mean that + @return Returns @false if initialization failed, it doesn't mean that another instance is running - use IsAnotherRunning() to check for it. */ diff --git a/interface/socket.h b/interface/socket.h index 32d3083e76..2312cf26e0 100644 --- a/interface/socket.h +++ b/interface/socket.h @@ -24,7 +24,7 @@ public: problems. Internally, this is the same as setting the IP address to @b INADDR_ANY. - @returns Returns @true on success, @false if something went wrong. + @return Returns @true on success, @false if something went wrong. */ bool AnyAddress(); @@ -107,7 +107,7 @@ public: or catch @b wxSOCKET_CONNECTION events, then call Accept once you know that there is an incoming connection waiting to be accepted. - @returns Returns an opened socket connection, or @NULL if an error + @return Returns an opened socket connection, or @NULL if an error occurred or if the wait parameter was @false and there were no pending connections. @@ -122,7 +122,7 @@ public: @param socket Socket to be initialized - @returns Returns @true on success, or @false if an error occurred or if the + @return Returns @true on success, or @false if an error occurred or if the wait parameter was @false and there were no pending connections. */ @@ -141,7 +141,7 @@ public: @param millisecond Number of milliseconds to wait. - @returns Returns @true if an incoming connection arrived, @false if the + @return Returns @true if an incoming connection arrived, @false if the timeout elapsed. */ bool WaitForAccept(long seconds = -1, long millisecond = 0); @@ -170,7 +170,7 @@ public: On IPV4 implementations, 0.0.0.0 On IPV6 implementations, :: - @returns Returns @true on success, @false if something went wrong. + @return Returns @true on success, @false if something went wrong. */ virtual bool AnyAddress(); @@ -179,7 +179,7 @@ public: to @b INADDR_BROADCAST. On IPV4 implementations, 255.255.255.255 - @returns Returns @true on success, @false if something went wrong. + @return Returns @true on success, @false if something went wrong. */ virtual bool BroadcastAddress(); @@ -206,7 +206,7 @@ public: On IPV4 implementations, 127.0.0.1 On IPV6 implementations, ::1 - @returns Returns @true on success, @false if something went wrong. + @return Returns @true on success, @false if something went wrong. */ virtual bool LocalHost(); @@ -270,7 +270,7 @@ public: @param wait If @true, waits for the connection to complete. - @returns Returns @true if the connection is established and no error + @return Returns @true if the connection is established and no error occurs. @see WaitOnConnect(), wxSocketBase::SetNotify, @@ -293,7 +293,7 @@ public: @param millisecond Number of milliseconds to wait. - @returns WaitOnConnect returns @true if the connection request completes. + @return WaitOnConnect returns @true if the connection request completes. This does not necessarily mean that the connection was successfully established; it might also happen that the connection was refused by the peer. Use IsConnected to @@ -490,7 +490,7 @@ public: socket objects in the stack. Destroy calls Close() automatically. - @returns Always @true. + @return Always @true. */ bool Destroy(); @@ -525,7 +525,7 @@ public: address field contains the complete local address of the socket (local address, local port, ...). - @returns @true if no error happened, @false otherwise. + @return @true if no error happened, @false otherwise. */ bool GetLocal(wxSockAddress& addr) const; @@ -534,7 +534,7 @@ public: address field contains the complete peer host address of the socket (address, port, ...). - @returns @true if no error happened, @false otherwise. + @return @true if no error happened, @false otherwise. */ bool GetPeer(wxSockAddress& addr) const; @@ -634,7 +634,7 @@ public: @param nbytes Number of bytes. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. @see Error(), LastError(), LastCount(), SetFlags() @@ -651,7 +651,7 @@ public: @param nbytes Number of bytes. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. @see Error(), LastError(), LastCount(), SetFlags() @@ -671,7 +671,7 @@ public: @param nbytes Size of the buffer. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. @see Error(), LastError(), LastCount(), SetFlags(), WriteMsg() @@ -896,7 +896,7 @@ public: @param nbytes Number of bytes. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. @see Error(), LastCount(), LastError() */ @@ -920,7 +920,7 @@ public: @param millisecond Number of milliseconds to wait. - @returns Returns @true when any of the above conditions is satisfied, + @return Returns @true when any of the above conditions is satisfied, @false if the timeout was reached. @see InterruptWait(), wxSocketServer::WaitForAccept, @@ -940,7 +940,7 @@ public: @param millisecond Number of milliseconds to wait. - @returns Returns @true if the connection was lost, @false if the timeout + @return Returns @true if the connection was lost, @false if the timeout was reached. @see InterruptWait(), Wait() @@ -961,7 +961,7 @@ public: @param millisecond Number of milliseconds to wait. - @returns Returns @true if the socket becomes readable, @false on timeout. + @return Returns @true if the socket becomes readable, @false on timeout. @see InterruptWait(), Wait() */ @@ -981,7 +981,7 @@ public: @param millisecond Number of milliseconds to wait. - @returns Returns @true if the socket becomes writable, @false on timeout. + @return Returns @true if the socket becomes writable, @false on timeout. @see InterruptWait(), Wait() */ @@ -997,7 +997,7 @@ public: @param nbytes Number of bytes. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. @see Error(), LastError(), LastCount(), SetFlags() @@ -1018,7 +1018,7 @@ public: @param nbytes Number of bytes to send. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. */ wxSocketBase WriteMsg(const void* buffer, wxUint32 nbytes); }; @@ -1065,7 +1065,7 @@ public: @param nbytes Number of bytes. - @returns Returns a reference to the current object, and the address of + @return Returns a reference to the current object, and the address of the peer that sent the data on address param. @see wxSocketBase::Error, wxSocketBase::LastError, wxSocketBase::LastCount, @@ -1087,7 +1087,7 @@ public: @param nbytes Number of bytes. - @returns Returns a reference to the current object. + @return Returns a reference to the current object. */ wxDatagramSocket SendTo(const wxSockAddress& address, const void* buffer, diff --git a/interface/sound.h b/interface/sound.h index 34d910ee97..2d22a5b76c 100644 --- a/interface/sound.h +++ b/interface/sound.h @@ -50,7 +50,7 @@ public: @param isResource @true if fileName is a resource, @false if it is a filename. - @returns @true if the call was successful, @false otherwise. + @return @true if the call was successful, @false otherwise. */ bool Create(const wxString& fileName, bool isResource = false); diff --git a/interface/splitter.h b/interface/splitter.h index df7e890bf6..cf048023ed 100644 --- a/interface/splitter.h +++ b/interface/splitter.h @@ -290,7 +290,7 @@ public: (default) to choose the default position (half of the total window height). - @returns @true if successful, @false otherwise (the window was already + @return @true if successful, @false otherwise (the window was already split). @remarks This should be called if you wish to initially view two panes. @@ -319,7 +319,7 @@ public: (default) to choose the default position (half of the total window width). - @returns @true if successful, @false otherwise (the window was already + @return @true if successful, @false otherwise (the window was already split). @remarks This should be called if you wish to initially view two panes. @@ -339,7 +339,7 @@ public: @param toRemove The pane to remove, or @NULL to remove the right or bottom pane. - @returns @true if successful, @false otherwise (the window was not split). + @return @true if successful, @false otherwise (the window was not split). @remarks This call will not actually delete the pane being removed; it calls OnUnsplit which can be overridden for the desired diff --git a/interface/statusbr.h b/interface/statusbr.h index ca46d9f91c..2d4ca10da5 100644 --- a/interface/statusbr.h +++ b/interface/statusbr.h @@ -82,7 +82,7 @@ public: @param rect The rectangle values are placed in this variable. - @returns @true if the field index is valid, @false otherwise. + @return @true if the field index is valid, @false otherwise. @see wxRect */ @@ -99,7 +99,7 @@ public: @param i The number of the status field to retrieve, starting from zero. - @returns The status field string if the field is valid, otherwise the + @return The status field string if the field is valid, otherwise the empty string. @see SetStatusText() diff --git a/interface/strconv.h b/interface/strconv.h index 64d2ffe3b5..fafa722f2b 100644 --- a/interface/strconv.h +++ b/interface/strconv.h @@ -330,7 +330,7 @@ public: The length of the output buffer but including NUL, ignored if out is @NULL - @returns The length of the converted string excluding the trailing NUL. + @return The length of the converted string excluding the trailing NUL. */ virtual size_t MB2WC(wchar_t* out, const char* in, size_t outLen) const; diff --git a/interface/stream.h b/interface/stream.h index 4957165e01..532ac2d28d 100644 --- a/interface/stream.h +++ b/interface/stream.h @@ -217,7 +217,7 @@ public: The position is counted from the end of the stream. - @returns Upon successful completion, it returns the new offset as + @return Upon successful completion, it returns the new offset as measured in bytes from the beginning of the stream. Otherwise, it returns wxInvalidOffset. */ @@ -256,7 +256,7 @@ public: it gives you the position in the @e real stream counted from the start of the stream. - @returns Returns the current position in the stream if possible, + @return Returns the current position in the stream if possible, wxInvalidOffset in the other case. */ off_t Tell() const; @@ -332,7 +332,7 @@ public: @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - @returns The new stream position or wxInvalidOffset on error. + @return The new stream position or wxInvalidOffset on error. */ off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); @@ -634,7 +634,7 @@ public: Reads data from the input queue and stores it in the specified output stream. The data is read until an error is raised by one of the two streams. - @returns This function returns a reference on the current object, so the + @return This function returns a reference on the current object, so the user can test any states of the stream right away. */ wxInputStream Read(void* buffer, size_t size); @@ -652,7 +652,7 @@ public: @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - @returns The new stream position or wxInvalidOffset on error. + @return The new stream position or wxInvalidOffset on error. */ off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart); diff --git a/interface/textctrl.h b/interface/textctrl.h index 1c205b2db8..3422c07817 100644 --- a/interface/textctrl.h +++ b/interface/textctrl.h @@ -771,7 +771,7 @@ public: @since 2.9.0 - @returns @true if the auto-completion was enabled or @false if the + @return @true if the auto-completion was enabled or @false if the operation failed, typically because auto-completion is not supported by the current platform. @@ -787,7 +787,7 @@ public: @since 2.9.0 - @returns @true if the auto-completion was enabled or @false if the + @return @true if the auto-completion was enabled or @false if the operation failed, typically because auto-completion is not supported by the current platform. @@ -884,7 +884,7 @@ public: Please note that this function doesn't currently work correctly for all keys under any platform but MSW. - @returns @true if the event resulted in a change to the control, @false + @return @true if the event resulted in a change to the control, @false otherwise. */ bool EmulateKeyPress(const wxKeyEvent& event); @@ -920,7 +920,7 @@ public: @param lineNo Line number (starting from zero). - @returns The length of the line, or -1 if lineNo was invalid. + @return The length of the line, or -1 if lineNo was invalid. */ int GetLineLength(long lineNo) const; @@ -931,7 +931,7 @@ public: @param lineNo The line number, starting from zero. - @returns The contents of the line. + @return The contents of the line. */ wxString GetLineText(long lineNo) const; @@ -984,7 +984,7 @@ public: Returns the style at this position in the text control. Not all platforms support this function. - @returns @true on success, @false if an error occurred - it may also mean + @return @true on success, @false if an error occurred - it may also mean that the styles are not supported under this platform. @see SetStyle(), wxTextAttr @@ -1062,7 +1062,7 @@ public: @param fileType The type of file to load. This is currently ignored in wxTextCtrl. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. */ bool LoadFile(const wxString& filename, int fileType = wxTEXT_TYPE_ANY); @@ -1102,7 +1102,7 @@ public: @param y Receives zero based line number. - @returns @true on success, @false on failure (most likely due to a too + @return @true on success, @false on failure (most likely due to a too large position parameter). @see XYToPosition() @@ -1148,7 +1148,7 @@ public: @param fileType The type of file to save. This is currently ignored in wxTextCtrl. - @returns @true if the operation was successful, @false otherwise. + @return @true if the operation was successful, @false otherwise. */ bool SaveFile(const wxString& filename, int fileType = wxTEXT_TYPE_ANY); @@ -1168,7 +1168,7 @@ public: @param style The style for the new text. - @returns @true on success, @false if an error occurred - may also mean that + @return @true on success, @false if an error occurred - may also mean that the styles are not supported under this platform. @see GetDefaultStyle() @@ -1255,7 +1255,7 @@ public: @param style The new style for the range. - @returns @true on success, @false if an error occurred - it may also mean + @return @true on success, @false if an error occurred - it may also mean that the styles are not supported under this platform. @see GetStyle(), wxTextAttr @@ -1313,7 +1313,7 @@ public: @param y The line number. - @returns The position value, or -1 if x or y was invalid. + @return The position value, or -1 if x or y was invalid. */ long XYToPosition(long x, long y); diff --git a/interface/tglbtn.h b/interface/tglbtn.h index 5384e9c50d..4a679c7ee1 100644 --- a/interface/tglbtn.h +++ b/interface/tglbtn.h @@ -89,7 +89,7 @@ public: /** Gets the state of the toggle button. - @returns Returns @true if it is pressed, @false otherwise. + @return Returns @true if it is pressed, @false otherwise. */ bool GetValue() const; @@ -154,7 +154,7 @@ public: /** Gets the state of the toggle button. - @returns Returns @true if it is pressed, @false otherwise. + @return Returns @true if it is pressed, @false otherwise. */ virtual bool GetValue() const; diff --git a/interface/thread.h b/interface/thread.h index 5f07abb5ed..1f44a6597e 100644 --- a/interface/thread.h +++ b/interface/thread.h @@ -91,7 +91,7 @@ public: and so it is important to ensure that the condition will be signalled after Wait or the thread may sleep forever. - @returns Returns wxCOND_NO_ERROR on success, another value if an error + @return Returns wxCOND_NO_ERROR on success, another value if an error occurred. @see WaitTimeout() @@ -226,7 +226,7 @@ public: it. You may optionally specify the stack size to be allocated to it (Ignored on platforms that don't support setting it explicitly, eg. Unix). - @returns One of: + @return One of: */ wxThreadError Create(unsigned int stackSize = 0); @@ -382,7 +382,7 @@ public: unless you explicitly specify a smaller amount of thread stack space for each thread. - @returns One of: + @return One of: */ wxThreadError Create(unsigned int stackSize = 0); @@ -788,14 +788,14 @@ public: threads in an atomic way. Returns wxSEMA_OVERFLOW if the count would increase the counter past the maximum. - @returns One of: + @return One of: */ wxSemaError Post(); /** Same as Wait(), but returns immediately. - @returns One of: + @return One of: */ wxSemaError TryWait(); @@ -803,7 +803,7 @@ public: Wait indefinitely until the semaphore count becomes strictly positive and then decrement it and return. - @returns One of: + @return One of: */ wxSemaError Wait(); }; @@ -894,28 +894,28 @@ public: Locks the mutex object. This is equivalent to LockTimeout() with infinite timeout. - @returns One of: + @return One of: */ wxMutexError Lock(); /** Try to lock the mutex object during the specified time interval. - @returns One of: + @return One of: */ wxMutexError LockTimeout(unsigned long msec); /** Tries to lock the mutex object. If it can't, returns immediately with an error. - @returns One of: + @return One of: */ wxMutexError TryLock(); /** Unlocks the mutex object. - @returns One of: + @return One of: */ wxMutexError Unlock(); }; diff --git a/interface/toolbar.h b/interface/toolbar.h index 821c32025e..7c7714b9af 100644 --- a/interface/toolbar.h +++ b/interface/toolbar.h @@ -265,7 +265,7 @@ public: @param y Y position. - @returns A pointer to a tool if a tool is found, or @NULL otherwise. + @return A pointer to a tool if a tool is found, or @NULL otherwise. @remarks Currently not implemented in wxGTK (always returns @NULL there). */ @@ -297,7 +297,7 @@ public: @param toolId Id of the tool, as passed to AddTool(). - @returns Client data, or @NULL if there is none. + @return Client data, or @NULL if there is none. */ wxObject* GetToolClientData(int toolId) const; @@ -307,7 +307,7 @@ public: @param toolId Id of the tool in question. - @returns @true if the tool is enabled, @false otherwise. + @return @true if the tool is enabled, @false otherwise. @see EnableTool() */ @@ -368,7 +368,7 @@ public: @param toolId The tool in question. - @returns @true if the tool is toggled on, @false otherwise. + @return @true if the tool is toggled on, @false otherwise. @see ToggleTool() */ @@ -424,7 +424,7 @@ public: @param toggleDown @true if the tool is a toggle and the toggle is down, otherwise is @false. - @returns If the tool is a toggle and this function returns @false, the + @return If the tool is a toggle and this function returns @false, the toggle toggle state (internal and visual) will not be changed. This provides a way of specifying that toggle operations are not permitted in some circumstances. diff --git a/interface/url.h b/interface/url.h index dbfd083567..3d7eea0c99 100644 --- a/interface/url.h +++ b/interface/url.h @@ -85,7 +85,7 @@ public: } @endcode - @returns Returns the initialized stream. You will have to delete it + @return Returns the initialized stream. You will have to delete it yourself. @see wxInputStream diff --git a/interface/utils.h b/interface/utils.h index 357d282232..41ca90a8b4 100644 --- a/interface/utils.h +++ b/interface/utils.h @@ -515,7 +515,7 @@ wxString wxStripMenuCodes(const wxString& str, int flags = wxStrip_All); Copies the user's email address into the supplied buffer, by concatenating the values returned by wxGetFullHostName() and wxGetUserId(). - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @header{wx/utils.h} */ @@ -527,7 +527,7 @@ wxString wxGetEmailAddress(); @param buf Buffer to store the email address in. @param sz Size of the buffer. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @header{wx/utils.h} */ @@ -559,7 +559,7 @@ wxString wxGetHomeDir(); SYSTEM_NAME; if this is not found, the entry @b HostName in the wxWidgets section of the WIN.INI file is tried. - @returns The hostname if successful or an empty string otherwise. + @return The hostname if successful or an empty string otherwise. @see wxGetFullHostName() @@ -573,7 +573,7 @@ wxString wxGetHostName(); @param buf Buffer to store the host name in. @param sz Size of the buffer. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @header{wx/utils.h} */ @@ -607,7 +607,7 @@ wxString wxGetUserHome(const wxString& user = ""); environment variables USER and LOGNAME; if neither of these is found, the entry @b UserId in the @b wxWidgets section of the WIN.INI file is tried. - @returns The login name if successful or an empty string otherwise. + @return The login name if successful or an empty string otherwise. @see wxGetUserName() @@ -621,7 +621,7 @@ wxString wxGetUserId(); @param buf Buffer to store the login name in. @param sz Size of the buffer. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @header{wx/utils.h} */ @@ -634,7 +634,7 @@ bool wxGetUserId(char* buf, int sz); wxWidgets section of the WIN.INI file. If PenWindows is running, the entry Current in the section User of the PENWIN.INI file is used. - @returns The full user name if successful or an empty string otherwise. + @return The full user name if successful or an empty string otherwise. @see wxGetUserId() @@ -648,7 +648,7 @@ wxString wxGetUserName(); @param buf Buffer to store the full user name in. @param sz Size of the buffer. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @header{wx/utils.h} */ @@ -950,7 +950,7 @@ bool wxShell(const wxString& command = NULL); @param flags Either wxSHUTDOWN_POWEROFF or wxSHUTDOWN_REBOOT - @returns @true on success, @false if an error occurred. + @return @true on success, @false if an error occurred. @header{wx/utils.h} */ diff --git a/interface/validate.h b/interface/validate.h index 272db6b433..76f4abd835 100644 --- a/interface/validate.h +++ b/interface/validate.h @@ -63,7 +63,7 @@ public: brushes, it does not make sense to have a reference counting scheme to do this cloning because all validators should have separate data. - @returns This base function returns @NULL. + @return This base function returns @NULL. */ virtual wxObject* Clone() const; diff --git a/interface/vlbox.h b/interface/vlbox.h index e63e92b600..d376222010 100644 --- a/interface/vlbox.h +++ b/interface/vlbox.h @@ -68,7 +68,7 @@ public: @c wxLB_MULTIPLE which indicates that the listbox should support multiple selection. - @returns @true on success or @false if the control couldn't be created. + @return @true on success or @false if the control couldn't be created. */ bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, @@ -79,7 +79,7 @@ public: Deselects all the items in the listbox. This method is only valid for multi selection listboxes. - @returns @true if any items were changed, i.e. if there had been any + @return @true if any items were changed, i.e. if there had been any selected items before, or @false if all the items were already deselected. @@ -239,7 +239,7 @@ public: Selects or deselects the specified item which must be valid (i.e. not equal to @c wxNOT_FOUND). - @returns @true if the items selection status has changed or @false + @return @true if the items selection status has changed or @false otherwise. This function is only valid for the multiple selection listboxes, use @@ -250,7 +250,7 @@ public: /** Selects all the items in the listbox. - @returns @true if any items were changed, i.e. if there had been any + @return @true if any items were changed, i.e. if there had been any unselected items before, or @false if all the items were already selected. @@ -264,7 +264,7 @@ public: Selects all items in the specified range which may be given in any order. - @returns @true if the items selection status has changed or @false + @return @true if the items selection status has changed or @false otherwise. This method is only valid for multi selection listboxes. diff --git a/interface/vscroll.h b/interface/vscroll.h index bf58f2023d..c5acde34e3 100644 --- a/interface/vscroll.h +++ b/interface/vscroll.h @@ -304,9 +304,9 @@ public: Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up). - @returns @true if the window was scrolled, @false otherwise (for - example, if we're trying to scroll down but we are already - showing the last row). + @return @true if the window was scrolled, @false otherwise (for + example, if we're trying to scroll down but we are already + showing the last row). */ virtual bool ScrollRows(int rows); @@ -314,7 +314,7 @@ public: Scroll to the specified row. It will become the first visible row in the window. - @returns @true if we scrolled the window, @false if nothing was done. + @return @true if we scrolled the window, @false if nothing was done. */ bool ScrollToRow(size_t row); @@ -441,9 +441,9 @@ public: Scroll by the specified number of columns which may be positive (to scroll right) or negative (to scroll left). - @returns @true if the window was scrolled, @false otherwise (for - example, if we're trying to scroll right but we are already - showing the last column). + @return @true if the window was scrolled, @false otherwise (for + example, if we're trying to scroll right but we are already + showing the last column). */ virtual bool ScrollColumns(int columns); @@ -451,7 +451,7 @@ public: Scroll to the specified column. It will become the first visible column in the window. - @returns @true if we scrolled the window, @false if nothing was done. + @return @true if we scrolled the window, @false if nothing was done. */ bool ScrollToColumn(size_t column); diff --git a/interface/window.h b/interface/window.h index 5d191b645f..79235c42ca 100644 --- a/interface/window.h +++ b/interface/window.h @@ -422,7 +422,7 @@ public: non-existent windows. - @returns @true if the window has either been successfully deleted, or it + @return @true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. */ @@ -436,7 +436,7 @@ public: /** Disables the window, same as @ref enable() Enable(@false). - @returns Returns @true if the window has been disabled, @false if it had + @return Returns @true if the window has been disabled, @false if it had been already disabled before the call to this function. */ bool Disable(); @@ -491,7 +491,7 @@ public: @param enable If @true, enables the window for input. If @false, disables the window. - @returns Returns @true if the window has been enabled or disabled, @false + @return Returns @true if the window has been enabled or disabled, @false if nothing was done, i.e. if the window had already been in the specified state. @@ -978,7 +978,7 @@ public: @param y The vertical position of the menu - @returns The selected menu item id or wxID_NONE if none selected or an + @return The selected menu item id or wxID_NONE if none selected or an error occurred. */ int GetPopupMenuSelectionFromUser(wxMenu& menu, @@ -1180,7 +1180,7 @@ public: Navigate() if the key event is one normally used for keyboard navigation and return @true in this case. - @returns Returns @true if the key pressed was for navigation and was + @return Returns @true if the key pressed was for navigation and was handled, @false otherwise. @see Navigate() @@ -1473,7 +1473,7 @@ public: A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange. - @returns Returns @true if the focus was moved to another window or @false + @return Returns @true if the focus was moved to another window or @false if nothing changed. @remarks You may wish to call this from a text control custom keypress @@ -1501,7 +1501,7 @@ public: @param count The number of sequential IDs to reserve. - @returns Returns the ID or the first ID of the range, or wxID_NONE if the + @return Returns the ID or the first ID of the range, or wxID_NONE if the specified number of identifiers couldn't be allocated. @see UnreserveControlId(), wxIdManager, @ref overview_windowidsoverview @@ -1656,7 +1656,7 @@ public: @param virtualKeyCode The virtual key code of the hotkey. - @returns @true if the hotkey was registered successfully. @false if some + @return @true if the hotkey was registered successfully. @false if some other application already registered a hotkey with this modifier/virtualKeyCode combination. @@ -1697,7 +1697,7 @@ public: The event handler to remove, must be non-@NULL and must be present in this windows event handlers chain - @returns Returns @true if it was found and @false otherwise (this also + @return Returns @true if it was found and @false otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there). @@ -1735,7 +1735,7 @@ public: Scrolls the window by the given number of lines down (if @a lines is positive) or up. - @returns Returns @true if the window was scrolled, @false if it was already + @return Returns @true if the window was scrolled, @false if it was already on top/bottom and nothing was done. @remarks This function is currently only implemented under MSW and @@ -1750,7 +1750,7 @@ public: Scrolls the window by the given number of pages down (if @a pages is positive) or up. - @returns Returns @true if the window was scrolled, @false if it was already + @return Returns @true if the window was scrolled, @false if it was already on top/bottom and nothing was done. @remarks This function is currently only implemented under MSW and wxGTK. @@ -2021,7 +2021,7 @@ public: Font to associate with this window, pass wxNullFont to reset to the default font. - @returns @true if the want was really changed, @false if it was already set + @return @true if the want was really changed, @false if it was already set to this font and so nothing was done. @see GetFont(), InheritAttributes() @@ -2446,7 +2446,7 @@ public: @param show If @true displays the window. Otherwise, hides it. - @returns @true if the window has been shown or hidden or @false if nothing + @return @true if the window has been shown or hidden or @false if nothing was done because it already was in the requested state. @see IsShown(), Hide(), wxRadioBox::Show @@ -2494,7 +2494,7 @@ public: Also, please notice that not all styles can be changed after the control creation. - @returns Returns @true if the style was turned on by this function, @false + @return Returns @true if the style was turned on by this function, @false if it was switched off. @see SetWindowStyleFlag(), HasFlag() @@ -2518,7 +2518,7 @@ public: If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows. - @returns Returns @false if a transfer failed. + @return Returns @false if a transfer failed. @see TransferDataFromWindow(), wxValidator, Validate() */ @@ -2531,7 +2531,7 @@ public: Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey. - @returns @true if the hotkey was unregistered successfully, @false if the + @return @true if the hotkey was unregistered successfully, @false if the id was invalid. @remarks This function is currently only implemented under MSW. @@ -2596,7 +2596,7 @@ public: If the window has @c wxWS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. - @returns Returns @false if any of the validations failed. + @return Returns @false if any of the validations failed. @see TransferDataFromWindow(), TransferDataToWindow(), wxValidator diff --git a/interface/windowid.h b/interface/windowid.h index c6a13bef14..7b14cce3ed 100644 --- a/interface/windowid.h +++ b/interface/windowid.h @@ -35,7 +35,7 @@ public: @param count The number of sequential IDs to reserve. - @returns The value of the first ID in the sequence, or wxID_NONE. + @return The value of the first ID in the sequence, or wxID_NONE. */ static wxWindowID ReserveControlId(int count = 1); }; diff --git a/interface/wxcrt.h b/interface/wxcrt.h index d51d80bd5e..f30ed8982c 100644 --- a/interface/wxcrt.h +++ b/interface/wxcrt.h @@ -10,7 +10,7 @@ //@{ /** - @returns @true if the pointer is either @NULL or points to an empty string, + @return @true if the pointer is either @NULL or points to an empty string, @false otherwise. @header{wx/wxcrt.h} @@ -30,7 +30,7 @@ size_t wxStrlen(const char* p); This function complements the standard C function @e stricmp() which performs case-insensitive comparison. - @returns A negative value, 0, or positive value if @a p1 is less than, + @return A negative value, 0, or positive value if @a p1 is less than, equal to or greater than @a p2. The comparison is case-sensitive. @header{wx/wxcrt.h} @@ -41,7 +41,7 @@ int wxStrcmp(const char* p1, const char* p2); This function complements the standard C function @e strcmp() which performs case-sensitive comparison. - @returns A negative value, 0, or positive value if @a p1 is less than, + @return A negative value, 0, or positive value if @a p1 is less than, equal to or greater than @e p2. The comparison is case-insensitive. @header{wx/wxcrt.h} -- 2.45.2