Fix double words and article mismatches in docs.

This commit is contained in:
Blake Madden
2021-03-10 14:28:20 -05:00
parent 18edbe93f2
commit 28d705424b
34 changed files with 46 additions and 46 deletions

View File

@@ -1246,7 +1246,7 @@ bool wxSafeYield(wxWindow* win = NULL, bool onlyIfNeeded = false);
This function initializes wxWidgets in a platform-dependent way. Use this if you This function initializes wxWidgets in a platform-dependent way. Use this if you
are not using the default wxWidgets entry code (e.g. main or WinMain). are not using the default wxWidgets entry code (e.g. main or WinMain).
For example, you can initialize wxWidgets from an Microsoft Foundation Classes For example, you can initialize wxWidgets from a Microsoft Foundation Classes
(MFC) application using this function. (MFC) application using this function.
@note This overload of wxEntry is available under all platforms. @note This overload of wxEntry is available under all platforms.

View File

@@ -133,7 +133,7 @@ const char* wxART_EDIT;
@section artprovider_identify Identifying art resources @section artprovider_identify Identifying art resources
Every bitmap and icon bundle are known to wxArtProvider under an unique ID that Every bitmap and icon bundle are known to wxArtProvider under a unique ID that
is used when requesting a resource from it. The ID is represented by the ::wxArtID type is used when requesting a resource from it. The ID is represented by the ::wxArtID type
and can have one of these predefined values (you can see bitmaps represented by these and can have one of these predefined values (you can see bitmaps represented by these
constants in the @ref page_samples_artprov): constants in the @ref page_samples_artprov):

View File

@@ -110,7 +110,7 @@ public:
@param size @param size
Initial size. Initial size.
@param choices @param choices
An wxArrayString with which to initialise the control. A wxArrayString with which to initialise the control.
@param style @param style
The window style, see wxCB_* flags. The window style, see wxCB_* flags.
@param validator @param validator

View File

@@ -1403,7 +1403,7 @@ public:
void ExpandAncestors( const wxDataViewItem & item ); void ExpandAncestors( const wxDataViewItem & item );
/** /**
Expand all all children of the given item recursively. Expand all children of the given item recursively.
This is the same as calling Expand() on the @a item itself and then This is the same as calling Expand() on the @a item itself and then
calling it for all of its children, grandchildren etc recursively. calling it for all of its children, grandchildren etc recursively.

View File

@@ -4311,7 +4311,7 @@ public:
/** /**
@class wxMouseCaptureChangedEvent @class wxMouseCaptureChangedEvent
An mouse capture changed event is sent to a window that loses its A mouse capture changed event is sent to a window that loses its
mouse capture. This is called even if wxWindow::ReleaseMouse mouse capture. This is called even if wxWindow::ReleaseMouse
was called by the application code. Handling this event allows was called by the application code. Handling this event allows
an application to cater for unexpected capture releases which an application to cater for unexpected capture releases which

View File

@@ -26,7 +26,7 @@
CreateToolBar() functions, manages these windows and adjusts the value returned CreateToolBar() functions, manages these windows and adjusts the value returned
by GetClientSize() to reflect the remaining size available to application windows. by GetClientSize() to reflect the remaining size available to application windows.
@remarks An application should normally define an wxCloseEvent handler for the @remarks An application should normally define a wxCloseEvent handler for the
frame to respond to system close events, for example so that related frame to respond to system close events, for example so that related
data and subwindows can be cleaned up. data and subwindows can be cleaned up.

View File

@@ -504,7 +504,7 @@ protected:
/** /**
This method is called when a mouse button is clicked inside wxHtmlWindow. This method is called when a mouse button is clicked inside wxHtmlWindow.
The default behaviour is to emit a wxHtmlCellEvent and, if the event was The default behaviour is to emit a wxHtmlCellEvent and, if the event was
not processed or skipped, call OnLinkClicked() if the cell contains an not processed or skipped, call OnLinkClicked() if the cell contains a
hypertext link. hypertext link.
Overloading this method is deprecated; intercept the event instead. Overloading this method is deprecated; intercept the event instead.

View File

@@ -1271,12 +1271,12 @@ public:
(http://www.libpng.org/pub/png/libpng-1.2.5-manual.html) for possible values (http://www.libpng.org/pub/png/libpng-1.2.5-manual.html) for possible values
(e.g. PNG_FILTER_NONE, PNG_FILTER_SUB, PNG_FILTER_UP, etc). (e.g. PNG_FILTER_NONE, PNG_FILTER_SUB, PNG_FILTER_UP, etc).
@li @c wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL: Compression level (0..9) for @li @c wxIMAGE_OPTION_PNG_COMPRESSION_LEVEL: Compression level (0..9) for
saving a PNG file. An high value creates smaller-but-slower PNG file. saving a PNG file. A high value creates smaller-but-slower PNG file.
Note that unlike other formats (e.g. JPEG) the PNG format is always Note that unlike other formats (e.g. JPEG) the PNG format is always
lossless and thus this compression level doesn't tradeoff the image lossless and thus this compression level doesn't tradeoff the image
quality. quality.
@li @c wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL: Compression memory usage @li @c wxIMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL: Compression memory usage
level (1..9) for saving a PNG file. An high value means the saving level (1..9) for saving a PNG file. A high value means the saving
process consumes more memory, but may create smaller PNG file. process consumes more memory, but may create smaller PNG file.
@li @c wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY: Possible values are 0 for @li @c wxIMAGE_OPTION_PNG_COMPRESSION_STRATEGY: Possible values are 0 for
default strategy, 1 for filter, and 2 for Huffman-only. default strategy, 1 for filter, and 2 for Huffman-only.

View File

@@ -278,7 +278,7 @@ public:
const_iterator end() const; const_iterator end() const;
/** /**
Returns a iterator pointing at the end of the list. Returns an iterator pointing at the end of the list.
*/ */
iterator end() const; iterator end() const;

View File

@@ -195,7 +195,7 @@ public:
Fill an array of ints with the positions of the currently selected items. Fill an array of ints with the positions of the currently selected items.
@param selections @param selections
A reference to an wxArrayInt instance that is used to store the result of A reference to a wxArrayInt instance that is used to store the result of
the query. the query.
@return The number of selections. @return The number of selections.

View File

@@ -106,7 +106,7 @@ public:
used for anything, but the wxMetafile object must still be destroyed by used for anything, but the wxMetafile object must still be destroyed by
the application. the application.
Below is a example of metafile, metafile device context and clipboard use Below is an example of metafile, metafile device context and clipboard use
from the @c hello.cpp example. Note the way the metafile dimensions from the @c hello.cpp example. Note the way the metafile dimensions
are passed to the clipboard, making use of the device context's ability are passed to the clipboard, making use of the device context's ability
to keep track of the maximum extent of drawing commands. to keep track of the maximum extent of drawing commands.

View File

@@ -481,7 +481,7 @@ public:
/** /**
This is an helper template class primarily written to avoid memory leaks because This is a helper template class primarily written to avoid memory leaks because
of missing calls to wxRefCounter::DecRef() and wxObjectRefData::DecRef(). of missing calls to wxRefCounter::DecRef() and wxObjectRefData::DecRef().
Despite the name this template can actually be used as a smart pointer for any Despite the name this template can actually be used as a smart pointer for any

View File

@@ -89,7 +89,7 @@ public:
wxOwnerDrawnComboBox(); wxOwnerDrawnComboBox();
/** /**
Constructor, creating and showing a owner-drawn combobox. Constructor, creating and showing an owner-drawn combobox.
@param parent @param parent
Parent window. Must not be @NULL. Parent window. Must not be @NULL.

View File

@@ -16,7 +16,7 @@
Base abstract class for all pickers which support an auxiliary text control. Base abstract class for all pickers which support an auxiliary text control.
This class handles all positioning and sizing of the text control like a This class handles all positioning and sizing of the text control like a
an horizontal wxBoxSizer would do, with the text control on the left of the a horizontal wxBoxSizer would do, with the text control on the left of the
picker button. picker button.
The proportion (see wxSizer documentation for more info about proportion values) The proportion (see wxSizer documentation for more info about proportion values)

View File

@@ -160,7 +160,7 @@ public:
Helper RAII class ensuring that power resources are released. Helper RAII class ensuring that power resources are released.
A wxPowerResourceBlocker object acquires a power resource in the A wxPowerResourceBlocker object acquires a power resource in the
constructor and releases it in the destructor making it impossible to to constructor and releases it in the destructor making it impossible to
forget to release the power resource (which would prevent suspending or forget to release the power resource (which would prevent suspending or
screen power off until the application ends). screen power off until the application ends).

View File

@@ -1016,7 +1016,7 @@ public:
@param value @param value
Int to get the value from. Int to get the value from.
@param flags @param flags
If has ::wxPG_FULL_VALUE, then the value given is a actual value and not an index. If has ::wxPG_FULL_VALUE, then the value given is an actual value and not an index.
@return @true if value was changed. @return @true if value was changed.
*/ */
@@ -2784,7 +2784,7 @@ public:
void EnsureData(); void EnsureData();
/** /**
Gets a unsigned number identifying this list. Gets an unsigned number identifying this list.
*/ */
wxPGChoicesId GetId() const; wxPGChoicesId GetId() const;

View File

@@ -1243,7 +1243,7 @@ public:
bool IsEditorsValueModified() const; bool IsEditorsValueModified() const;
/** /**
Shows an brief error message that is related to a property. Shows a brief error message that is related to a property.
*/ */
void ShowPropertyError( wxPGPropArg id, const wxString& msg ); void ShowPropertyError( wxPGPropArg id, const wxString& msg );

View File

@@ -851,7 +851,7 @@ public:
const wxString& falseChoice ); const wxString& falseChoice );
/** /**
Set proportion of a auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER Set proportion of an auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER
window style needs to be used to indicate that columns are auto- window style needs to be used to indicate that columns are auto-
resizable. resizable.
@@ -1062,7 +1062,7 @@ public:
@param maxLen @param maxLen
Maximum number of characters of the text the user can enter in Maximum number of characters of the text the user can enter in
the text editor. If it is 0, the length is not limited and the text the text editor. If it is 0, the length is not limited and the text
can be as long as it is supported by the the underlying native text can be as long as it is supported by the underlying native text
control widget. control widget.
@return @return
Returns @true if maximum length was set. Returns @true if maximum length was set.

View File

@@ -441,7 +441,7 @@ protected:
wxEnumProperty with wxString value and writable combo box editor. wxEnumProperty with wxString value and writable combo box editor.
@remarks @remarks
Uses int value, similar to wxEnumProperty, unless text entered by user is Uses int value, similar to wxEnumProperty, unless text entered by user
is not in choices (in which case string value is used). is not in choices (in which case string value is used).
*/ */
class wxEditEnumProperty : public wxEnumProperty class wxEditEnumProperty : public wxEnumProperty

View File

@@ -400,7 +400,7 @@ public:
virtual bool Detach(wxSizer* sizer); virtual bool Detach(wxSizer* sizer);
/** /**
Detach a item at position @a index from the sizer without destroying it. Detach an item at position @a index from the sizer without destroying it.
This method does not cause any layout or resizing to take place, call Layout() This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer. to update the layout "on screen" after detaching a child from the sizer.

View File

@@ -5022,7 +5022,7 @@ public:
int GetIMEInteraction() const; int GetIMEInteraction() const;
/** /**
Choose to display the the IME in a winow or inline. Choose to display the IME in a winow or inline.
The input should be one of the The input should be one of the
@link wxStyledTextCtrl::wxSTC_IME_WINDOWED wxSTC_IME_* @endlink constants. @link wxStyledTextCtrl::wxSTC_IME_WINDOWED wxSTC_IME_* @endlink constants.
@@ -5576,7 +5576,7 @@ public:
//@{ //@{
/** /**
Display a auto-completion list. Display an auto-completion list.
The lengthEntered parameter indicates how many characters before The lengthEntered parameter indicates how many characters before
the caret should be used to provide context. the caret should be used to provide context.
*/ */
@@ -8135,7 +8135,7 @@ public:
@c wxEVT_STC_INDICATOR_CLICK @c wxEVT_STC_INDICATOR_CLICK
- Generated when a indicator has been clicked. - Generated when an indicator has been clicked.
- Valid event functions: - Valid event functions:
@link wxStyledTextEvent::GetModifiers GetModifiers@endlink, @link wxStyledTextEvent::GetModifiers GetModifiers@endlink,

View File

@@ -745,7 +745,7 @@ public:
const TYPE ToAscii(char replaceWith = '_') const; const TYPE ToAscii(char replaceWith = '_') const;
/** /**
Return the string as an std::string using @e conv's wxMBConv::cWC2MB method. Return the string as a std::string using @e conv's wxMBConv::cWC2MB method.
Note that if the conversion of (Unicode) string contents using @e conv Note that if the conversion of (Unicode) string contents using @e conv
fails, the return string will be empty. Be sure to check for fails, the return string will be empty. Be sure to check for
@@ -768,7 +768,7 @@ public:
std::string ToStdString(const wxMBConv& conv = wxConvLibc) const; std::string ToStdString(const wxMBConv& conv = wxConvLibc) const;
/** /**
Return the string as an std::wstring. Return the string as a std::wstring.
Unlike ToStdString(), there is no danger of data loss when using this Unlike ToStdString(), there is no danger of data loss when using this
function. function.

View File

@@ -593,8 +593,8 @@ typedef wxVector<wxTaskBarJumpListCategory*> wxTaskBarJumpListCategories;
/** /**
@class wxTaskBarJumpList @class wxTaskBarJumpList
This class is an transparent wrapper around Windows Jump Lists. Jump This class is a transparent wrapper around Windows Jump Lists. Jump
Lists, as an new feature since Windows 7, are lists of recently opened Lists, as a new feature since Windows 7, are lists of recently opened
items, such as files, folders, or websites, which are organized by the items, such as files, folders, or websites, which are organized by the
program that the user use to open them. Jump Lists don't just show program that the user use to open them. Jump Lists don't just show
shortcuts to files. Sometimes they can also provide quick access to tasks. shortcuts to files. Sometimes they can also provide quick access to tasks.

View File

@@ -269,7 +269,7 @@ public:
/** /**
Returns the header value for header @a header. Returns the header value for header @a header.
The search for @a header is case sensitive. If an @a domain is passed, The search for @a header is case sensitive. If a @a domain is passed,
this domain is searched. Else all domains will be searched until a this domain is searched. Else all domains will be searched until a
header has been found. header has been found.

View File

@@ -500,7 +500,7 @@ public:
@name Methods for the tree navigation. @name Methods for the tree navigation.
The tree has an invisible root item which is the hidden parent of all The tree has an invisible root item which is the hidden parent of all
top-level items in the tree. Starting from it it is possible to iterate top-level items in the tree. Starting from it is possible to iterate
over all tree items using GetNextItem(). over all tree items using GetNextItem().
It is also possible to iterate over just the children of the given item It is also possible to iterate over just the children of the given item

View File

@@ -86,7 +86,7 @@ public:
wxChar GetChar(); wxChar GetChar();
/** /**
Reads a unsigned 16 bit integer from the stream. Reads an unsigned 16 bit integer from the stream.
See Read8() for the description of the @a base parameter. See Read8() for the description of the @a base parameter.
*/ */

View File

@@ -236,7 +236,7 @@ public:
wxVariant(void* value, const wxString& name = wxEmptyString); wxVariant(void* value, const wxString& name = wxEmptyString);
/** /**
Constructs a variant from a pointer to an wxObject Constructs a variant from a pointer to a wxObject
derived class. derived class.
*/ */
wxVariant(wxObject* value, const wxString& name = wxEmptyString); wxVariant(wxObject* value, const wxString& name = wxEmptyString);

View File

@@ -55,7 +55,7 @@ public:
range. range.
The @a InputIterator template parameter must be an input iterator type. The @a InputIterator template parameter must be an input iterator type.
This constructor adds all elements from @a first until, not not This constructor adds all elements from @a first until, not
including, @a last to the vector. including, @a last to the vector.
@since 2.9.5 @since 2.9.5

View File

@@ -480,7 +480,7 @@ protected:
the need to specify class scope in your wxHVScrolledWindow derived class the need to specify class scope in your wxHVScrolledWindow derived class
when using wxVarScrollHelperBase functionality. when using wxVarScrollHelperBase functionality.
Like all three of it's scroll helper base classes, this class is mostly Like all three of its scroll helper base classes, this class is mostly
only useful to those classes built into wxWidgets deriving from here, and only useful to those classes built into wxWidgets deriving from here, and
this documentation is mostly only provided for referencing the functions this documentation is mostly only provided for referencing the functions
provided by this class. You will likely want to derive your window from provided by this class. You will likely want to derive your window from

View File

@@ -720,7 +720,7 @@ public:
@a backend may be specified explicitly by using of the predefined @c @a backend may be specified explicitly by using of the predefined @c
wxWebSessionBackendWinHTTP, @c wxWebSessionBackendURLSession or @c wxWebSessionBackendWinHTTP, @c wxWebSessionBackendURLSession or @c
wxWebSessionBackendCURL constants to select the corresponding backend wxWebSessionBackendCURL constants to select the corresponding backend
or left empty to select the default backend. The default depends on the or left empty to select the default backend. The default depends on
the current platform: WinHTTP-based implementation is used under MSW, the current platform: WinHTTP-based implementation is used under MSW,
NSURLSession-based one under macOS and libcurl-based otherwise. NSURLSession-based one under macOS and libcurl-based otherwise.

View File

@@ -734,7 +734,7 @@ public:
Add a script message handler with the given name. Add a script message handler with the given name.
To use the script message handler from javascript use To use the script message handler from javascript use
@c window.<name>.postMessage(<messageBody>) where <name> corresponds the the value @c window.<name>.postMessage(<messageBody>) where <name> corresponds the value
of the name parameter. The <messageBody> will be available to the application of the name parameter. The <messageBody> will be available to the application
via a @c wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED event. via a @c wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED event.

View File

@@ -1918,10 +1918,10 @@ public:
Converts to screen coordinates from coordinates relative to this window. Converts to screen coordinates from coordinates relative to this window.
@param x @param x
A pointer to a integer value for the x coordinate. Pass the client A pointer to an integer value for the x coordinate. Pass the client
coordinate in, and a screen coordinate will be passed out. coordinate in, and a screen coordinate will be passed out.
@param y @param y
A pointer to a integer value for the y coordinate. Pass the client A pointer to an integer value for the y coordinate. Pass the client
coordinate in, and a screen coordinate will be passed out. coordinate in, and a screen coordinate will be passed out.
@beginWxPerlOnly @beginWxPerlOnly
@@ -2174,7 +2174,7 @@ public:
/** /**
Returns the region specifying which parts of the window have been damaged. Returns the region specifying which parts of the window have been damaged.
Should only be called within an wxPaintEvent handler. Should only be called within a wxPaintEvent handler.
@see wxRegion, wxRegionIterator @see wxRegion, wxRegionIterator
*/ */
@@ -2246,7 +2246,7 @@ public:
The colour to be used as the background colour; pass The colour to be used as the background colour; pass
wxNullColour to reset to the default colour. wxNullColour to reset to the default colour.
Note that you may want to use wxSystemSettings::GetColour() to retrieve Note that you may want to use wxSystemSettings::GetColour() to retrieve
a suitable colour to use rather than setting an hard-coded one. a suitable colour to use rather than setting a hard-coded one.
@remarks The background colour is usually painted by the default @remarks The background colour is usually painted by the default
wxEraseEvent event handler function under Windows and wxEraseEvent event handler function under Windows and
@@ -2873,7 +2873,7 @@ public:
/** /**
Returns @true if the given point or rectangle area has been exposed since the Returns @true if the given point or rectangle area has been exposed since the
last repaint. Call this in an paint event handler to optimize redrawing by last repaint. Call this in a paint event handler to optimize redrawing by
only redrawing those areas, which have been exposed. only redrawing those areas, which have been exposed.
*/ */
bool IsExposed(int x, int y) const; bool IsExposed(int x, int y) const;
@@ -3364,7 +3364,7 @@ public:
of a window, which may or may not be implemented by destroying of a window, which may or may not be implemented by destroying
the window. The default implementation of wxDialog::OnCloseWindow the window. The default implementation of wxDialog::OnCloseWindow
does not necessarily delete the dialog, since it will simply does not necessarily delete the dialog, since it will simply
simulate an wxID_CANCEL event which is handled by the appropriate simulate a wxID_CANCEL event which is handled by the appropriate
button event handler and may do anything at all. button event handler and may do anything at all.
To guarantee that the window will be destroyed, call To guarantee that the window will be destroyed, call
wxWindow::Destroy instead wxWindow::Destroy instead

View File

@@ -136,7 +136,7 @@ public:
virtual ~wxXmlNode(); virtual ~wxXmlNode();
/** /**
Appends a attribute with given @a name and @a value to the list of Appends an attribute with given @a name and @a value to the list of
attributes for this node. attributes for this node.
*/ */
virtual void AddAttribute(const wxString& name, const wxString& value); virtual void AddAttribute(const wxString& name, const wxString& value);

View File

@@ -118,7 +118,7 @@ class wxZipNotifier
{ {
public: public:
/** /**
Override this to receive notifications when an wxZipEntry object changes. Override this to receive notifications when a wxZipEntry object changes.
*/ */
virtual void OnEntryUpdated(wxZipEntry& entry) = 0; virtual void OnEntryUpdated(wxZipEntry& entry) = 0;
}; };