Fix spelling in comments and documentation using codespell
Apply the utility from https://github.com/codespell-project/codespell/ to fix spelling issues in the headers under both include and interface directories and add a file with a couple of exceptions. The exact command line used was: $ codespell -w -I misc/scripts/codespell.ignore -i 3 in*
This commit is contained in:
@@ -90,7 +90,7 @@ enum wxAuiToolBarStyle
|
||||
enum wxAuiToolBarArtSetting
|
||||
{
|
||||
/**
|
||||
wxAuiToolBar seperator size.
|
||||
wxAuiToolBar separator size.
|
||||
*/
|
||||
wxAUI_TBART_SEPARATOR_SIZE = 0,
|
||||
|
||||
|
@@ -445,7 +445,7 @@ public:
|
||||
@param height
|
||||
The height of the bitmap in pixels, must be strictly positive.
|
||||
@param dc
|
||||
DC from wich the scaling factor is inherited
|
||||
DC from which the scaling factor is inherited
|
||||
|
||||
@return @true if the creation was successful.
|
||||
|
||||
|
@@ -894,7 +894,7 @@ public:
|
||||
|
||||
For example:
|
||||
@code
|
||||
// this function loads somes settings from the given wxConfig object;
|
||||
// this function loads some settings from the given wxConfig object;
|
||||
// the path selected inside it is left unchanged
|
||||
bool LoadMySettings(wxConfigBase* cfg)
|
||||
{
|
||||
|
@@ -489,7 +489,7 @@ public:
|
||||
|
||||
Here are the trivial accessors. Other functions, which might have to
|
||||
perform some more complicated calculations to find the answer are under
|
||||
the "Date Arithmetics" section.
|
||||
the "Date Arithmetic" section.
|
||||
*/
|
||||
//@{
|
||||
|
||||
@@ -738,10 +738,10 @@ public:
|
||||
|
||||
|
||||
/**
|
||||
@name Date Arithmetics
|
||||
@name Date Arithmetic
|
||||
|
||||
These functions carry out
|
||||
@ref overview_datetime_arithmetics "arithmetics" on the wxDateTime
|
||||
@ref overview_datetime_arithmetics "arithmetic" on the wxDateTime
|
||||
objects. As explained in the overview, either wxTimeSpan or wxDateSpan
|
||||
may be added to wxDateTime, hence all functions are overloaded to
|
||||
accept both arguments.
|
||||
|
@@ -146,7 +146,7 @@ public:
|
||||
/**
|
||||
Sets the default action for drag and drop. Use wxDragMove or
|
||||
wxDragCopy to set default action to move or copy and use wxDragNone
|
||||
(default) to set default action specified by initialization of draging
|
||||
(default) to set default action specified by initialization of dragging
|
||||
(see wxDropSource::DoDragDrop())
|
||||
*/
|
||||
void SetDefaultAction(wxDragResult action);
|
||||
|
@@ -13,7 +13,7 @@
|
||||
#define wxGA_HORIZONTAL wxHORIZONTAL
|
||||
#define wxGA_VERTICAL wxVERTICAL
|
||||
|
||||
// Available since Windows 7 only. With this style, the value of guage will
|
||||
// Available since Windows 7 only. With this style, the value of gauge will
|
||||
// reflect on the taskbar button.
|
||||
#define wxGA_PROGRESS 0x0010
|
||||
// Win32 only, is default (and only) on some other platforms
|
||||
|
@@ -22,7 +22,7 @@
|
||||
To instantiate an object from your wxGenericAboutDialog-based class, you
|
||||
can use either the default constructor followed by a call to Create(), or
|
||||
directly using the alternate constructor. In either case, you have to
|
||||
prepare a wxAboutDialogInfo containing standard informations to display in
|
||||
prepare a wxAboutDialogInfo containing standard information to display in
|
||||
an about-box.
|
||||
|
||||
Example of usage, MyAboutDlg being a class derived from wxGenericAboutDialog:
|
||||
|
@@ -99,7 +99,7 @@ public:
|
||||
GetBestSize() should be called for each cell individually.
|
||||
|
||||
Note that this method will only be used if
|
||||
wxGridTableBase::CanMeasureColUsingSameAttr() is overriden to return
|
||||
wxGridTableBase::CanMeasureColUsingSameAttr() is overridden to return
|
||||
@true.
|
||||
|
||||
@since 3.1.4
|
||||
@@ -1326,7 +1326,7 @@ public:
|
||||
Returns @true if the cell will draw an overflowed text into the
|
||||
neighbouring cells.
|
||||
|
||||
Note that only left aligned cells currenty can overflow. It means that
|
||||
Note that only left aligned cells currently can overflow. It means that
|
||||
GetFitMode().IsOverflow() should returns true and GetAlignment should
|
||||
returns wxALIGN_LEFT for hAlign parameter.
|
||||
|
||||
|
@@ -668,7 +668,7 @@ public:
|
||||
By default, the log messages are passed to the previously active log target.
|
||||
Calling this function with @false parameter disables this behaviour
|
||||
(presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
|
||||
it can be reenabled by calling it again with @a passMessages set to @true.
|
||||
it can be re-enabled by calling it again with @a passMessages set to @true.
|
||||
*/
|
||||
void PassMessages(bool passMessages);
|
||||
|
||||
|
@@ -625,7 +625,7 @@ public:
|
||||
|
||||
/**
|
||||
Conversion to a boolean expression (in a variant which is not
|
||||
convertable to anything but a boolean expression).
|
||||
convertible to anything but a boolean expression).
|
||||
|
||||
If this class contains a valid pointer it will return @true, if it contains
|
||||
a @NULL pointer it will return @false.
|
||||
|
@@ -469,7 +469,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000
|
||||
@subsection wxIntProperty
|
||||
|
||||
It derives from wxNumericProperty and displays value as a signed long integer.
|
||||
wxIntProperty seamlessly supports 64-bit integers (i.e. wxLongLong) on overlfow.
|
||||
wxIntProperty seamlessly supports 64-bit integers (i.e. wxLongLong) on overflow.
|
||||
To safely convert variant to integer, use code like this:
|
||||
|
||||
@code
|
||||
@@ -1397,7 +1397,7 @@ public:
|
||||
Returns property attribute value, null variant if not found.
|
||||
|
||||
@remarks
|
||||
For built-in atrribute returns null variant if extra style
|
||||
For built-in attribute returns null variant if extra style
|
||||
::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set.
|
||||
*/
|
||||
wxVariant GetAttribute( const wxString& name ) const;
|
||||
@@ -1405,7 +1405,7 @@ public:
|
||||
/** Returns named attribute, as string, if found. Otherwise @a defVal is returned.
|
||||
|
||||
@remarks
|
||||
For built-in atrribute returns @a defVal if extra style
|
||||
For built-in attribute returns @a defVal if extra style
|
||||
::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set.
|
||||
*/
|
||||
wxString GetAttribute( const wxString& name, const wxString& defVal ) const;
|
||||
@@ -1413,7 +1413,7 @@ public:
|
||||
/** Returns named attribute, as long, if found. Otherwise @a defVal is returned.
|
||||
|
||||
@remarks
|
||||
For built-in atrribute returns @a defVal if extra style
|
||||
For built-in attribute returns @a defVal if extra style
|
||||
::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set.
|
||||
*/
|
||||
long GetAttributeAsLong( const wxString& name, long defVal ) const;
|
||||
@@ -1421,7 +1421,7 @@ public:
|
||||
/** Returns named attribute, as double, if found. Otherwise @a defVal is returned.
|
||||
|
||||
@remarks
|
||||
For built-in atrribute returns @a defVal if extra style
|
||||
For built-in attribute returns @a defVal if extra style
|
||||
::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set.
|
||||
*/
|
||||
double GetAttributeAsDouble( const wxString& name, double defVal ) const;
|
||||
|
@@ -315,7 +315,7 @@ public:
|
||||
virtual size_t GetToolCount() const;
|
||||
|
||||
/**
|
||||
Return the id assciated to the tool opaque structure.
|
||||
Return the id associated to the tool opaque structure.
|
||||
|
||||
The structure pointer must not be @NULL.
|
||||
|
||||
|
@@ -1206,7 +1206,7 @@ public:
|
||||
bool EndParagraphSpacing();
|
||||
|
||||
/**
|
||||
Begins appling line spacing. @e spacing is a multiple, where 10 means
|
||||
Begins applying line spacing. @e spacing is a multiple, where 10 means
|
||||
single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
|
||||
|
||||
The ::wxTextAttrLineSpacing constants are defined for convenience.
|
||||
|
@@ -86,7 +86,7 @@ public:
|
||||
|
||||
protected:
|
||||
/**
|
||||
This function must be overidden to process the given frame.
|
||||
This function must be overridden to process the given frame.
|
||||
*/
|
||||
virtual void OnStackFrame(const wxStackFrame& frame) = 0;
|
||||
};
|
||||
|
@@ -5324,7 +5324,7 @@ public:
|
||||
void MarkerSetBackgroundSelected(int markerNumber, const wxColour& back);
|
||||
|
||||
/**
|
||||
Enable/disable highlight for current folding bloc (smallest one that contains the caret)
|
||||
Enable/disable highlight for current folding block (smallest one that contains the caret)
|
||||
*/
|
||||
void MarkerEnableHighlight(bool enabled);
|
||||
|
||||
@@ -7927,7 +7927,7 @@ public:
|
||||
@section event_types Event Types
|
||||
|
||||
The following is a brief description of when the control generates these
|
||||
events and a list of which methods provide relevent information. Additional
|
||||
events and a list of which methods provide relevant information. Additional
|
||||
details can be found in the Scintilla documentation
|
||||
(http://www.scintilla.org/ScintillaDoc.html#Notifications).
|
||||
|
||||
|
@@ -90,7 +90,7 @@ public:
|
||||
/**
|
||||
Default constructor.
|
||||
|
||||
Notice that this class is not copyable, comparators are not passed by
|
||||
Notice that this class is not copiable, comparators are not passed by
|
||||
value.
|
||||
*/
|
||||
wxTreeListItemComparator();
|
||||
|
@@ -19,7 +19,7 @@
|
||||
|
||||
The main purpose of wxUString is a to give users a Unicode string
|
||||
class that has O(1) access to its content, to be identical on all
|
||||
platforms and to be easily convertable to wxString as well as other
|
||||
platforms and to be easily convertible to wxString as well as other
|
||||
ways to store strings (C string literals, wide character
|
||||
string literals, character buffer, etc) by providing several overloads
|
||||
and built-in conversions to and from the various string formats.
|
||||
|
@@ -62,7 +62,7 @@ enum wxTextValidatorStyle
|
||||
/// wxFILTER_ASCII, wxFILTER_ALPHA, wxFILTER_ALPHANUMERIC, wxFILTER_DIGITS,
|
||||
/// wxFILTER_XDIGITS, wxFILTER_NUMERIC it just extends the character class
|
||||
/// denoted by the aforementioned styles with those specified in the include
|
||||
/// char list. If set alone, then the charactes allowed to be in the user input
|
||||
/// char list. If set alone, then the characters allowed to be in the user input
|
||||
/// are restricted to those, and only those, present in the include char list.
|
||||
wxFILTER_INCLUDE_CHAR_LIST,
|
||||
|
||||
|
@@ -164,7 +164,7 @@ class wxWebViewHistoryItem
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Construtor.
|
||||
Constructor.
|
||||
*/
|
||||
wxWebViewHistoryItem(const wxString& url, const wxString& title);
|
||||
|
||||
|
@@ -1964,7 +1964,7 @@ public:
|
||||
Freezes the window or, in other words, prevents any updates from taking
|
||||
place on screen, the window is not redrawn at all.
|
||||
|
||||
Thaw() must be called to reenable window redrawing. Calls to these two
|
||||
Thaw() must be called to re-enable window redrawing. Calls to these two
|
||||
functions may be nested but to ensure that the window is properly
|
||||
repainted again, you must thaw it exactly as many times as you froze it.
|
||||
|
||||
@@ -2855,7 +2855,7 @@ public:
|
||||
|
||||
/**
|
||||
Enable or disable the window for user input. Note that when a parent window is
|
||||
disabled, all of its children are disabled as well and they are reenabled again
|
||||
disabled, all of its children are disabled as well and they are re-enabled again
|
||||
when the parent is.
|
||||
|
||||
A window can be created initially disabled by calling this method on it
|
||||
|
Reference in New Issue
Block a user