AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix various documentation warnings throughout core and base.

Browse Source 
See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74691 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Steve Lamerton 2013-08-21 15:26:34 +00:00
parent 2f36b4d22b
commit 8c6471af3c
15 changed files with 41 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
interface/wx/affinematrix2d.h
View File

@ -83,7 +83,7 @@ public:
//@{
/**
Check that this matrix is identical with @t.
Check that this matrix is identical with @a t.
@param t
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
The matrix compared with this.

8
interface/wx/affinematrix2dbase.h
View File

@ -116,7 +116,7 @@ public:
//@{
/**
Check that this matrix is identical with @t.
Check that this matrix is identical with @a t.
@param t
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
The matrix compared with this.
@ -181,7 +181,7 @@ public:
@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;
/**
@ -192,7 +192,7 @@ public:
@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;
};

2
interface/wx/control.h
View File

@ -103,6 +103,8 @@ public:
obviously not correctly sized.
@param style
Control style. For generic window styles, please see wxWindow.
@param validator
Control validator.
@param name
Control name.
*/

4
interface/wx/dcsvg.h
View File

@ -70,7 +70,7 @@ public:
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
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
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.
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.
*/
void DestroyClippingRegion();

4
interface/wx/dir.h
View File

@ -256,7 +256,7 @@ public:
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.
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
GetNameWithSep() instead to avoid having duplicate consecutive slashes.
*/
@ -265,7 +265,7 @@ public:
/**
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.
@see GetName()

5
interface/wx/event.h
View File

@ -3470,7 +3470,7 @@ public:
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.
The application may handle events generated using the keyboard or mouse
@ -3886,7 +3886,8 @@ public:
/**
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);

15
interface/wx/iconbndl.h
View File

@ -114,13 +114,14 @@ public:
If the bundle contains an icon with exactly the requested size, it's
always returned. Otherwise, the behaviour depends on the flags. If only
::FALLBACK_NONE is given, the function returns an invalid icon. If
::FALLBACK_SYSTEM is given, it tries to find the icon of standard
system size, regardless of the size passed as parameter. Otherwise, or
if the icon system size is not found neither, but
::FALLBACK_NEAREST_LARGER flag is specified, the function returns the
smallest icon of the size larger than the requested one or, if this
fails too, just the icon closest to the specified size.
wxIconBundle::FALLBACK_NONE is given, the function returns an invalid
icon. If wxIconBundle::FALLBACK_SYSTEM is given, it tries to find the
icon of standard system size, regardless of the size passed as
parameter. Otherwise, or if the icon system size is not found neither,
but wxIconBundle::FALLBACK_NEAREST_LARGER flag is specified, the
function returns the smallest icon of the size larger than the
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.
*/

2
interface/wx/intl.h
View File

@ -454,7 +454,7 @@ public:
@param name
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
directory prefix when looking for the message catalog files.
@param locale

2
interface/wx/simplebook.h
View File

@ -30,7 +30,7 @@
wxEVT_BOOKCTRL_PAGE_CHANGED events for the events it generates if
the program calls SetSelection().
@library{none}
@library{wxcore}
@category{bookctrl}
@see wxBookCtrl, wxNotebook, @ref page_samples_notebook

2
interface/wx/stopwatch.h
View File

@ -24,7 +24,7 @@
wxLogMessage("And calling it twice took $ldms in all", sw.Time());
@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
precision than the usual timer functions but can suffer from bugs in its
implementation in some Windows XP versions. If you encounter such problems,

8
interface/wx/thread.h
View File

@ -1217,9 +1217,9 @@ public:
The following symbolic constants can be used in addition to raw
values in 0..100 range:
- ::wxPRIORITY_MIN: 0
- ::wxPRIORITY_DEFAULT: 50
- ::wxPRIORITY_MAX: 100
- @c wxPRIORITY_MIN: 0
- @c wxPRIORITY_DEFAULT: 50
- @c wxPRIORITY_MAX: 100
*/
void SetPriority(unsigned int priority);
@ -1261,7 +1261,7 @@ public:
This function can only be called from another thread context.
@param waitMode
@param flags
As described in wxThreadWait documentation, wxTHREAD_WAIT_BLOCK
should be used as the wait mode even although currently
wxTHREAD_WAIT_YIELD is for compatibility reasons. This parameter is

6
interface/wx/toolbar.h
View File

@ -883,6 +883,8 @@ public:
@param id
ID of the tool in question, as passed to AddTool().
@param clientData
The client data to use.
*/
virtual void SetToolClientData(int id, wxObject* clientData);
@ -893,6 +895,8 @@ public:
@param id
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
the disabled bitmap from the normal bitmap, so this function will
@ -922,6 +926,8 @@ public:
@param id
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);

2
interface/wx/treelist.h
View File

@ -459,6 +459,8 @@ public:
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
last one.
@param text
The item text.
@param imageClosed
The normal item image, may be NO_IMAGE to not show any image.
@param imageOpened

2
interface/wx/utils.h
View File

@ -590,7 +590,7 @@ wxLoadUserResource(const void **outData,
@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
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.
This function is available under Windows only.

2
interface/wx/wizard.h
View File

@ -247,6 +247,8 @@ public:
@since 2.9.5
*/
wxWizardPageSimple& Chain(wxWizardPageSimple* next)
/**
A convenience function to make the pages follow each other.
Example: