Fix spelling and punctuation errors in comments and documentation
Fix several occurrences of misspelling "trivial" as "trival"; use "from" rather than "than"; add missing articles and commas. Closes https://github.com/wxWidgets/wxWidgets/pull/874
This commit is contained in:
committed by
Vadim Zeitlin
parent
de1322a02d
commit
e1a7f56040
@@ -670,9 +670,9 @@ public:
|
||||
This macro declares a new object array class named @a name and containing
|
||||
the elements of type @e T.
|
||||
|
||||
An exported array is used when compiling wxWidgets as a DLL under Windows
|
||||
and the array needs to be visible outside the DLL. An user exported array
|
||||
needed for exporting an array from a user DLL.
|
||||
An exported array is used when compiling wxWidgets as a DLL under Windows,
|
||||
and the array needs to be visible outside the DLL. A user-exported array
|
||||
is needed for exporting an array from a user DLL.
|
||||
|
||||
Example:
|
||||
|
||||
@@ -681,8 +681,8 @@ public:
|
||||
WX_DECLARE_OBJARRAY(MyClass, wxArrayOfMyClass); // note: not "MyClass *"!
|
||||
@endcode
|
||||
|
||||
You must use WX_DEFINE_OBJARRAY() macro to define the array class,
|
||||
otherwise you would get link errors.
|
||||
You must use the WX_DEFINE_OBJARRAY() macro to define the array class;
|
||||
otherwise, you will get link errors.
|
||||
*/
|
||||
#define WX_DECLARE_OBJARRAY(T, name)
|
||||
#define WX_DECLARE_EXPORTED_OBJARRAY(T, name)
|
||||
@@ -695,8 +695,8 @@ public:
|
||||
elements of type @a T.
|
||||
|
||||
An exported array is used when compiling wxWidgets as a DLL under Windows
|
||||
and the array needs to be visible outside the DLL. An user exported array
|
||||
needed for exporting an array from a user DLL.
|
||||
and the array needs to be visible outside the DLL. A user-exported array
|
||||
is needed for exporting an array from a user DLL.
|
||||
|
||||
Example:
|
||||
|
||||
@@ -728,8 +728,8 @@ public:
|
||||
destructor will not be called.
|
||||
|
||||
An exported array is used when compiling wxWidgets as a DLL under Windows
|
||||
and the array needs to be visible outside the DLL. An user exported array
|
||||
needed for exporting an array from a user DLL.
|
||||
and the array needs to be visible outside the DLL. A user-exported array
|
||||
is needed for exporting an array from a user DLL.
|
||||
|
||||
Example of usage:
|
||||
|
||||
@@ -760,8 +760,8 @@ public:
|
||||
the elements of type @e T.
|
||||
|
||||
An exported array is used when compiling wxWidgets as a DLL under Windows
|
||||
and the array needs to be visible outside the DLL. An user exported array
|
||||
needed for exporting an array from a user DLL.
|
||||
and the array needs to be visible outside the DLL. A user-exported array
|
||||
is needed for exporting an array from a user DLL.
|
||||
|
||||
Example:
|
||||
|
||||
|
@@ -749,7 +749,7 @@ public:
|
||||
Returns @true if the font is a fixed width (or monospaced) font,
|
||||
@false if it is a proportional one or font is invalid.
|
||||
|
||||
Note that this function under some platforms is different than just testing
|
||||
Note that this function under some platforms is different from just testing
|
||||
for the font family being equal to @c wxFONTFAMILY_TELETYPE because native
|
||||
platform-specific functions are used for the check (resulting in a more
|
||||
accurate return value).
|
||||
|
@@ -4645,7 +4645,7 @@ protected:
|
||||
/**
|
||||
Get the minimal width of the given column/row.
|
||||
|
||||
The value returned by this function may be different than that returned
|
||||
The value returned by this function may be different from that returned
|
||||
by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
|
||||
called for this column.
|
||||
*/
|
||||
@@ -4664,7 +4664,7 @@ protected:
|
||||
/**
|
||||
Returns the minimal size for the given column.
|
||||
|
||||
The value returned by this function may be different than that returned
|
||||
The value returned by this function may be different from that returned
|
||||
by GetRowMinimalAcceptableHeight() if SetRowMinimalHeight() had been
|
||||
called for this row.
|
||||
*/
|
||||
|
@@ -86,7 +86,7 @@
|
||||
wxIntegerEqual,
|
||||
MyHash );
|
||||
|
||||
// using an user-defined class for keys
|
||||
// using a user-defined class for keys
|
||||
class MyKey { ... };
|
||||
|
||||
// hashing function
|
||||
|
@@ -73,7 +73,7 @@
|
||||
wxIntegerEqual,
|
||||
MySet );
|
||||
|
||||
// using an user-defined class for keys
|
||||
// using a user-defined class for keys
|
||||
class MyKey { ... };
|
||||
|
||||
// hashing function
|
||||
|
@@ -143,7 +143,7 @@ public:
|
||||
@event{EVT_HTML_CELL_HOVER(id, func)}
|
||||
The mouse passed over a wxHtmlCell.
|
||||
@event{EVT_HTML_LINK_CLICKED(id, func)}
|
||||
A wxHtmlCell which contains an hyperlink was clicked.
|
||||
A wxHtmlCell which contains a hyperlink was clicked.
|
||||
@endEventTable
|
||||
|
||||
@library{wxhtml}
|
||||
@@ -555,7 +555,7 @@ wxEventType wxEVT_HTML_LINK_CLICKED;
|
||||
|
||||
@beginEventTable{wxHtmlLinkEvent}
|
||||
@event{EVT_HTML_LINK_CLICKED(id, func)}
|
||||
User clicked on an hyperlink.
|
||||
User clicked on a hyperlink.
|
||||
@endEventTable
|
||||
|
||||
@library{wxhtml}
|
||||
|
@@ -10,7 +10,7 @@
|
||||
|
||||
wxHtmlListBox is an implementation of wxVListBox which shows HTML content in
|
||||
the listbox rows. This is still an abstract base class and you will need to
|
||||
derive your own class from it (see htlbox sample for the example) but you will
|
||||
derive your own class from it (see htlbox sample for the example), but you will
|
||||
only need to override a single wxHtmlListBox::OnGetItem function.
|
||||
|
||||
@beginEventEmissionTable{wxHtmlCellEvent,wxHtmlLinkEvent}
|
||||
@@ -19,7 +19,7 @@
|
||||
@event{EVT_HTML_CELL_HOVER(id, func)}
|
||||
The mouse passed over a wxHtmlCell.
|
||||
@event{EVT_HTML_LINK_CLICKED(id, func)}
|
||||
A wxHtmlCell which contains an hyperlink was clicked.
|
||||
A wxHtmlCell which contains a hyperlink was clicked.
|
||||
@endEventTable
|
||||
|
||||
@library{wxhtml}
|
||||
@@ -191,7 +191,7 @@ protected:
|
||||
@event{EVT_HTML_CELL_HOVER(id, func)}
|
||||
The mouse passed over a wxHtmlCell. See wxHtmlCellEvent.
|
||||
@event{EVT_HTML_LINK_CLICKED(id, func)}
|
||||
A wxHtmlCell which contains an hyperlink was clicked. See wxHtmlLinkEvent
|
||||
A wxHtmlCell which contains a hyperlink was clicked. See wxHtmlLinkEvent
|
||||
@endEventTable
|
||||
|
||||
@library{wxhtml}
|
||||
|
@@ -18,7 +18,7 @@
|
||||
|
||||
@beginEventTable{wxHyperlinkEvent}
|
||||
@event{EVT_HYPERLINK(id, func)}
|
||||
User clicked on an hyperlink.
|
||||
User clicked on a hyperlink.
|
||||
@endEventTable
|
||||
|
||||
@library{wxadv}
|
||||
|
@@ -245,7 +245,7 @@ public:
|
||||
wxBitmapType GetType() const;
|
||||
|
||||
/**
|
||||
Loads a image from a stream, putting the resulting data into @a image.
|
||||
Loads an image from a stream, putting the resulting data into @a image.
|
||||
|
||||
If the image file contains more than one image and the image handler is
|
||||
capable of retrieving these individually, @a index indicates which image
|
||||
@@ -269,7 +269,7 @@ public:
|
||||
bool verbose = true, int index = -1);
|
||||
|
||||
/**
|
||||
Saves a image in the output stream.
|
||||
Saves an image in the output stream.
|
||||
|
||||
@param image
|
||||
The image object which is to be affected by this operation.
|
||||
|
@@ -59,7 +59,7 @@ template <class C>
|
||||
class wxSystemThemedControl : public C
|
||||
{
|
||||
public:
|
||||
/// Trival default constructor.
|
||||
/// Trivial default constructor.
|
||||
wxSystemThemedControl();
|
||||
|
||||
/**
|
||||
|
@@ -150,11 +150,11 @@ public:
|
||||
The date part of @a dt is ignored, only the time part is displayed in
|
||||
the control. The @a dt object must however be valid.
|
||||
|
||||
In particular notice that it is a bad idea to use default wxDateTime
|
||||
In particular, notice that it is a bad idea to use default wxDateTime
|
||||
constructor from hour, minute and second values as it uses the today
|
||||
date for the date part which means that some times can be invalid if
|
||||
date for the date part, which means that some values can be invalid if
|
||||
today happens to be the day of DST change. For example, when switching
|
||||
to summer time the time 2:00 typically doesn't exist as the clocks jump
|
||||
to summer time, the time 2:00 typically doesn't exist as the clocks jump
|
||||
directly to 3:00. To avoid this problem, use a fixed date on which DST
|
||||
is known not to change (e.g. Jan 1, 2012) for the date part of the
|
||||
argument or use SetTime().
|
||||
|
@@ -598,11 +598,11 @@ public:
|
||||
Set the format of the archive.
|
||||
|
||||
The normal zip format is limited to single files and the complete
|
||||
archive smaller than 4GB with less then 65k files. If any of these
|
||||
archive smaller than 4GB with less than 65k files. If any of these
|
||||
limits are exceeded, this class will automatically create a ZIP64 file,
|
||||
so in most situations calling SetFormat() is not necessary.
|
||||
|
||||
However to support single entries with more than 4GB of data
|
||||
However, to support single entries with more than 4GB of data
|
||||
(compressed or original) whose sizes are unknown when adding the
|
||||
entry with PutNextEntry(), the format has to be set to
|
||||
wxZIP_FORMAT_ZIP64 before adding such entries.
|
||||
|
Reference in New Issue
Block a user