Fix various documentation warnings throughout core and base.
See #15346. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74691 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -83,7 +83,7 @@ public:
|
|||||||
|
|
||||||
//@{
|
//@{
|
||||||
/**
|
/**
|
||||||
Check that this matrix is identical with @t.
|
Check that this matrix is identical with @a t.
|
||||||
|
|
||||||
@param t
|
@param t
|
||||||
The matrix compared with this.
|
The matrix compared with this.
|
||||||
@@ -93,7 +93,7 @@ public:
|
|||||||
//@}
|
//@}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Check that this matrix differs from @t.
|
Check that this matrix differs from @a t.
|
||||||
|
|
||||||
@param t
|
@param t
|
||||||
The matrix compared with this.
|
The matrix compared with this.
|
||||||
|
@@ -116,7 +116,7 @@ public:
|
|||||||
|
|
||||||
//@{
|
//@{
|
||||||
/**
|
/**
|
||||||
Check that this matrix is identical with @t.
|
Check that this matrix is identical with @a t.
|
||||||
|
|
||||||
@param t
|
@param t
|
||||||
The matrix compared with this.
|
The matrix compared with this.
|
||||||
@@ -126,7 +126,7 @@ public:
|
|||||||
//@}
|
//@}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Check that this matrix differs from @t.
|
Check that this matrix differs from @a t.
|
||||||
|
|
||||||
@param t
|
@param t
|
||||||
The matrix compared with this.
|
The matrix compared with this.
|
||||||
@@ -181,7 +181,7 @@ public:
|
|||||||
|
|
||||||
@return The point with the transformations applied.
|
@return The point with the transformations applied.
|
||||||
*/
|
*/
|
||||||
wxPoint2DDouble TransformPoint(const wxPoint2DDouble& src) const;
|
wxPoint2DDouble TransformPoint(const wxPoint2DDouble& p) const;
|
||||||
void TransformPoint(wxDouble* x, wxDouble* y) const;
|
void TransformPoint(wxDouble* x, wxDouble* y) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -192,7 +192,7 @@ public:
|
|||||||
|
|
||||||
@return The source with the transformations applied.
|
@return The source with the transformations applied.
|
||||||
*/
|
*/
|
||||||
wxPoint2DDouble TransformDistance(const wxPoint2DDouble& src) const;
|
wxPoint2DDouble TransformDistance(const wxPoint2DDouble& p) const;
|
||||||
void TransformDistance(wxDouble* dx, wxDouble* dy) const;
|
void TransformDistance(wxDouble* dx, wxDouble* dy) const;
|
||||||
|
|
||||||
};
|
};
|
||||||
|
@@ -103,6 +103,8 @@ public:
|
|||||||
obviously not correctly sized.
|
obviously not correctly sized.
|
||||||
@param style
|
@param style
|
||||||
Control style. For generic window styles, please see wxWindow.
|
Control style. For generic window styles, please see wxWindow.
|
||||||
|
@param validator
|
||||||
|
Control validator.
|
||||||
@param name
|
@param name
|
||||||
Control name.
|
Control name.
|
||||||
*/
|
*/
|
||||||
|
@@ -70,7 +70,7 @@ public:
|
|||||||
Sets the clipping region for this device context to the intersection of
|
Sets the clipping region for this device context to the intersection of
|
||||||
the given region described by the parameters of this method and the previously
|
the given region described by the parameters of this method and the previously
|
||||||
set clipping region.
|
set clipping region.
|
||||||
Clipping is implemented in the SVG output using SVG group elements (<g>), with
|
Clipping is implemented in the SVG output using SVG group elements (\<g\>), with
|
||||||
nested group elements being used to represent clipping region intersections when
|
nested group elements being used to represent clipping region intersections when
|
||||||
two or more calls are made to SetClippingRegion().
|
two or more calls are made to SetClippingRegion().
|
||||||
*/
|
*/
|
||||||
@@ -98,7 +98,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
Destroys the current clipping region so that none of the DC is clipped.
|
Destroys the current clipping region so that none of the DC is clipped.
|
||||||
Since intersections arising from sequential calls to SetClippingRegion are represented
|
Since intersections arising from sequential calls to SetClippingRegion are represented
|
||||||
with nested SVG group elements (<g>), all such groups are closed when
|
with nested SVG group elements (\<g\>), all such groups are closed when
|
||||||
DestroyClippingRegion is called.
|
DestroyClippingRegion is called.
|
||||||
*/
|
*/
|
||||||
void DestroyClippingRegion();
|
void DestroyClippingRegion();
|
||||||
|
@@ -256,7 +256,7 @@ public:
|
|||||||
|
|
||||||
Notice that in spite of this the last character of the returned string
|
Notice that in spite of this the last character of the returned string
|
||||||
can still be the path separator if this directory is the root one.
|
can still be the path separator if this directory is the root one.
|
||||||
Because of this, don't append ::wxFILE_SEP_PATH to the returned value
|
Because of this, don't append @c wxFILE_SEP_PATH to the returned value
|
||||||
if you do need a slash-terminated directory name but use
|
if you do need a slash-terminated directory name but use
|
||||||
GetNameWithSep() instead to avoid having duplicate consecutive slashes.
|
GetNameWithSep() instead to avoid having duplicate consecutive slashes.
|
||||||
*/
|
*/
|
||||||
@@ -265,7 +265,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
Returns the name of the directory with the path separator appended.
|
Returns the name of the directory with the path separator appended.
|
||||||
|
|
||||||
The last character of the returned string is always ::wxFILE_SEP_PATH
|
The last character of the returned string is always @c wxFILE_SEP_PATH
|
||||||
unless the string is empty, indicating that this directory is invalid.
|
unless the string is empty, indicating that this directory is invalid.
|
||||||
|
|
||||||
@see GetName()
|
@see GetName()
|
||||||
|
@@ -3470,7 +3470,7 @@ public:
|
|||||||
wxHelpEvent::Origin origin = Origin_Unknown);
|
wxHelpEvent::Origin origin = Origin_Unknown);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns the origin of the help event which is one of the ::wxHelpEventOrigin
|
Returns the origin of the help event which is one of the wxHelpEvent::Origin
|
||||||
values.
|
values.
|
||||||
|
|
||||||
The application may handle events generated using the keyboard or mouse
|
The application may handle events generated using the keyboard or mouse
|
||||||
@@ -3886,7 +3886,8 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
Sets the flags for this event.
|
Sets the flags for this event.
|
||||||
The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
|
The @a flags can be a combination of the
|
||||||
|
wxNavigationKeyEvent::wxNavigationKeyEventFlags values.
|
||||||
*/
|
*/
|
||||||
void SetFlags(long flags);
|
void SetFlags(long flags);
|
||||||
|
|
||||||
|
@@ -114,13 +114,14 @@ public:
|
|||||||
|
|
||||||
If the bundle contains an icon with exactly the requested size, it's
|
If the bundle contains an icon with exactly the requested size, it's
|
||||||
always returned. Otherwise, the behaviour depends on the flags. If only
|
always returned. Otherwise, the behaviour depends on the flags. If only
|
||||||
::FALLBACK_NONE is given, the function returns an invalid icon. If
|
wxIconBundle::FALLBACK_NONE is given, the function returns an invalid
|
||||||
::FALLBACK_SYSTEM is given, it tries to find the icon of standard
|
icon. If wxIconBundle::FALLBACK_SYSTEM is given, it tries to find the
|
||||||
system size, regardless of the size passed as parameter. Otherwise, or
|
icon of standard system size, regardless of the size passed as
|
||||||
if the icon system size is not found neither, but
|
parameter. Otherwise, or if the icon system size is not found neither,
|
||||||
::FALLBACK_NEAREST_LARGER flag is specified, the function returns the
|
but wxIconBundle::FALLBACK_NEAREST_LARGER flag is specified, the
|
||||||
smallest icon of the size larger than the requested one or, if this
|
function returns the smallest icon of the size larger than the
|
||||||
fails too, just the icon closest to the specified size.
|
requested one or, if this fails too, just the icon closest to the
|
||||||
|
specified size.
|
||||||
|
|
||||||
The @a flags parameter is available only since wxWidgets 2.9.4.
|
The @a flags parameter is available only since wxWidgets 2.9.4.
|
||||||
*/
|
*/
|
||||||
|
@@ -454,7 +454,7 @@ public:
|
|||||||
|
|
||||||
@param name
|
@param name
|
||||||
The name of the locale. Only used in diagnostic messages.
|
The name of the locale. Only used in diagnostic messages.
|
||||||
@param short
|
@param shortName
|
||||||
The standard 2 letter locale abbreviation; it is used as the
|
The standard 2 letter locale abbreviation; it is used as the
|
||||||
directory prefix when looking for the message catalog files.
|
directory prefix when looking for the message catalog files.
|
||||||
@param locale
|
@param locale
|
||||||
|
@@ -30,7 +30,7 @@
|
|||||||
wxEVT_BOOKCTRL_PAGE_CHANGED events for the events it generates if
|
wxEVT_BOOKCTRL_PAGE_CHANGED events for the events it generates if
|
||||||
the program calls SetSelection().
|
the program calls SetSelection().
|
||||||
|
|
||||||
@library{none}
|
@library{wxcore}
|
||||||
@category{bookctrl}
|
@category{bookctrl}
|
||||||
|
|
||||||
@see wxBookCtrl, wxNotebook, @ref page_samples_notebook
|
@see wxBookCtrl, wxNotebook, @ref page_samples_notebook
|
||||||
|
@@ -24,7 +24,7 @@
|
|||||||
wxLogMessage("And calling it twice took $ldms in all", sw.Time());
|
wxLogMessage("And calling it twice took $ldms in all", sw.Time());
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
Since wxWidgets 2.9.3 this class uses @c ::QueryPerformanceCounter()
|
Since wxWidgets 2.9.3 this class uses @c QueryPerformanceCounter()
|
||||||
function under MSW to measure the elapsed time. It provides higher
|
function under MSW to measure the elapsed time. It provides higher
|
||||||
precision than the usual timer functions but can suffer from bugs in its
|
precision than the usual timer functions but can suffer from bugs in its
|
||||||
implementation in some Windows XP versions. If you encounter such problems,
|
implementation in some Windows XP versions. If you encounter such problems,
|
||||||
|
@@ -1217,9 +1217,9 @@ public:
|
|||||||
|
|
||||||
The following symbolic constants can be used in addition to raw
|
The following symbolic constants can be used in addition to raw
|
||||||
values in 0..100 range:
|
values in 0..100 range:
|
||||||
- ::wxPRIORITY_MIN: 0
|
- @c wxPRIORITY_MIN: 0
|
||||||
- ::wxPRIORITY_DEFAULT: 50
|
- @c wxPRIORITY_DEFAULT: 50
|
||||||
- ::wxPRIORITY_MAX: 100
|
- @c wxPRIORITY_MAX: 100
|
||||||
*/
|
*/
|
||||||
void SetPriority(unsigned int priority);
|
void SetPriority(unsigned int priority);
|
||||||
|
|
||||||
@@ -1261,7 +1261,7 @@ public:
|
|||||||
|
|
||||||
This function can only be called from another thread context.
|
This function can only be called from another thread context.
|
||||||
|
|
||||||
@param waitMode
|
@param flags
|
||||||
As described in wxThreadWait documentation, wxTHREAD_WAIT_BLOCK
|
As described in wxThreadWait documentation, wxTHREAD_WAIT_BLOCK
|
||||||
should be used as the wait mode even although currently
|
should be used as the wait mode even although currently
|
||||||
wxTHREAD_WAIT_YIELD is for compatibility reasons. This parameter is
|
wxTHREAD_WAIT_YIELD is for compatibility reasons. This parameter is
|
||||||
|
@@ -883,6 +883,8 @@ public:
|
|||||||
|
|
||||||
@param id
|
@param id
|
||||||
ID of the tool in question, as passed to AddTool().
|
ID of the tool in question, as passed to AddTool().
|
||||||
|
@param clientData
|
||||||
|
The client data to use.
|
||||||
*/
|
*/
|
||||||
virtual void SetToolClientData(int id, wxObject* clientData);
|
virtual void SetToolClientData(int id, wxObject* clientData);
|
||||||
|
|
||||||
@@ -893,6 +895,8 @@ public:
|
|||||||
|
|
||||||
@param id
|
@param id
|
||||||
ID of the tool in question, as passed to AddTool().
|
ID of the tool in question, as passed to AddTool().
|
||||||
|
@param bitmap
|
||||||
|
Bitmap to use for disabled tools.
|
||||||
|
|
||||||
@note The native toolbar classes on the main platforms all synthesize
|
@note The native toolbar classes on the main platforms all synthesize
|
||||||
the disabled bitmap from the normal bitmap, so this function will
|
the disabled bitmap from the normal bitmap, so this function will
|
||||||
@@ -922,6 +926,8 @@ public:
|
|||||||
|
|
||||||
@param id
|
@param id
|
||||||
ID of the tool in question, as passed to AddTool().
|
ID of the tool in question, as passed to AddTool().
|
||||||
|
@param bitmap
|
||||||
|
Bitmap to use for normals tools.
|
||||||
*/
|
*/
|
||||||
virtual void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
|
virtual void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
|
||||||
|
|
||||||
|
@@ -459,6 +459,8 @@ public:
|
|||||||
wxTLI_FIRST or wxTLI_LAST indicating that the item should be either
|
wxTLI_FIRST or wxTLI_LAST indicating that the item should be either
|
||||||
inserted before the first child of its parent (if any) or after the
|
inserted before the first child of its parent (if any) or after the
|
||||||
last one.
|
last one.
|
||||||
|
@param text
|
||||||
|
The item text.
|
||||||
@param imageClosed
|
@param imageClosed
|
||||||
The normal item image, may be NO_IMAGE to not show any image.
|
The normal item image, may be NO_IMAGE to not show any image.
|
||||||
@param imageOpened
|
@param imageOpened
|
||||||
|
@@ -590,7 +590,7 @@ wxLoadUserResource(const void **outData,
|
|||||||
@param module The @c HINSTANCE of the module to load the resources from.
|
@param module The @c HINSTANCE of the module to load the resources from.
|
||||||
The current module is used by default. This parameter is new since
|
The current module is used by default. This parameter is new since
|
||||||
wxWidgets 2.9.1.
|
wxWidgets 2.9.1.
|
||||||
@return A pointer to the data to be <tt>delete[]<tt>d by caller on success
|
@return A pointer to the data to be <tt>delete[]</tt>d by caller on success
|
||||||
or @NULL on error.
|
or @NULL on error.
|
||||||
|
|
||||||
This function is available under Windows only.
|
This function is available under Windows only.
|
||||||
|
@@ -247,6 +247,8 @@ public:
|
|||||||
|
|
||||||
@since 2.9.5
|
@since 2.9.5
|
||||||
*/
|
*/
|
||||||
|
wxWizardPageSimple& Chain(wxWizardPageSimple* next)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
A convenience function to make the pages follow each other.
|
A convenience function to make the pages follow each other.
|
||||||
Example:
|
Example:
|
||||||
|
Reference in New Issue
Block a user