From 8c6471af3cf87c97f5f1564c601237caf9fdeb60 Mon Sep 17 00:00:00 2001 From: Steve Lamerton Date: Wed, 21 Aug 2013 15:26:34 +0000 Subject: [PATCH] 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 --- interface/wx/affinematrix2d.h | 4 ++-- interface/wx/affinematrix2dbase.h | 8 ++++---- interface/wx/control.h | 2 ++ interface/wx/dcsvg.h | 4 ++-- interface/wx/dir.h | 4 ++-- interface/wx/event.h | 5 +++-- interface/wx/iconbndl.h | 15 ++++++++------- interface/wx/intl.h | 2 +- interface/wx/simplebook.h | 2 +- interface/wx/stopwatch.h | 2 +- interface/wx/thread.h | 8 ++++---- interface/wx/toolbar.h | 6 ++++++ interface/wx/treelist.h | 2 ++ interface/wx/utils.h | 2 +- interface/wx/wizard.h | 2 ++ 15 files changed, 41 insertions(+), 27 deletions(-) diff --git a/interface/wx/affinematrix2d.h b/interface/wx/affinematrix2d.h index 99f84c4371..97ae8db0ec 100644 --- a/interface/wx/affinematrix2d.h +++ b/interface/wx/affinematrix2d.h @@ -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. diff --git a/interface/wx/affinematrix2dbase.h b/interface/wx/affinematrix2dbase.h index 0d18095ce9..e7d0a6df11 100644 --- a/interface/wx/affinematrix2dbase.h +++ b/interface/wx/affinematrix2dbase.h @@ -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; }; diff --git a/interface/wx/control.h b/interface/wx/control.h index d171f2666f..2c0f8f74e7 100644 --- a/interface/wx/control.h +++ b/interface/wx/control.h @@ -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. */ diff --git a/interface/wx/dcsvg.h b/interface/wx/dcsvg.h index 675c3ecbef..23ad44c6b4 100644 --- a/interface/wx/dcsvg.h +++ b/interface/wx/dcsvg.h @@ -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 (), with + Clipping is implemented in the SVG output using SVG group elements (\), 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 (), all such groups are closed when + with nested SVG group elements (\), all such groups are closed when DestroyClippingRegion is called. */ void DestroyClippingRegion(); diff --git a/interface/wx/dir.h b/interface/wx/dir.h index eae73a235b..d9a9c0dae7 100644 --- a/interface/wx/dir.h +++ b/interface/wx/dir.h @@ -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() diff --git a/interface/wx/event.h b/interface/wx/event.h index 3ae57ac40d..618d95a8ab 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -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); diff --git a/interface/wx/iconbndl.h b/interface/wx/iconbndl.h index 138e19c174..217adb464a 100644 --- a/interface/wx/iconbndl.h +++ b/interface/wx/iconbndl.h @@ -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. */ diff --git a/interface/wx/intl.h b/interface/wx/intl.h index 1f16708437..e34f200bac 100644 --- a/interface/wx/intl.h +++ b/interface/wx/intl.h @@ -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 diff --git a/interface/wx/simplebook.h b/interface/wx/simplebook.h index fb88948f5b..b0ae879436 100644 --- a/interface/wx/simplebook.h +++ b/interface/wx/simplebook.h @@ -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 diff --git a/interface/wx/stopwatch.h b/interface/wx/stopwatch.h index 096bd36ca6..c08d15d28d 100644 --- a/interface/wx/stopwatch.h +++ b/interface/wx/stopwatch.h @@ -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, diff --git a/interface/wx/thread.h b/interface/wx/thread.h index 1b3954f321..5ec3a58a8c 100644 --- a/interface/wx/thread.h +++ b/interface/wx/thread.h @@ -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 diff --git a/interface/wx/toolbar.h b/interface/wx/toolbar.h index c85bdcf919..08bcaa1ca9 100644 --- a/interface/wx/toolbar.h +++ b/interface/wx/toolbar.h @@ -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); diff --git a/interface/wx/treelist.h b/interface/wx/treelist.h index 54d679506b..6928a2d91d 100644 --- a/interface/wx/treelist.h +++ b/interface/wx/treelist.h @@ -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 diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 5573a19b93..53fea4e6bb 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -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 delete[]d by caller on success + @return A pointer to the data to be delete[]d by caller on success or @NULL on error. This function is available under Windows only. diff --git a/interface/wx/wizard.h b/interface/wx/wizard.h index 954f73fcd8..0164c8cbae 100644 --- a/interface/wx/wizard.h +++ b/interface/wx/wizard.h @@ -247,6 +247,8 @@ public: @since 2.9.5 */ + wxWizardPageSimple& Chain(wxWizardPageSimple* next) + /** A convenience function to make the pages follow each other. Example: -- 2.45.2