]> git.saurik.com Git - wxWidgets.git/commitdiff
Fix various documentation warnings throughout core and base.
authorSteve Lamerton <steve.lamerton@gmail.com>
Wed, 21 Aug 2013 15:26:34 +0000 (15:26 +0000)
committerSteve Lamerton <steve.lamerton@gmail.com>
Wed, 21 Aug 2013 15:26:34 +0000 (15:26 +0000)
See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74691 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

15 files changed:
interface/wx/affinematrix2d.h
interface/wx/affinematrix2dbase.h
interface/wx/control.h
interface/wx/dcsvg.h
interface/wx/dir.h
interface/wx/event.h
interface/wx/iconbndl.h
interface/wx/intl.h
interface/wx/simplebook.h
interface/wx/stopwatch.h
interface/wx/thread.h
interface/wx/toolbar.h
interface/wx/treelist.h
interface/wx/utils.h
interface/wx/wizard.h

index 99f84c4371dd39672882170926ae01cf9479998d..97ae8db0ec04c4df5c365ae3b484bbf6144c14e8 100644 (file)
@@ -83,7 +83,7 @@ public:
 
     //@{
     /**
-        Check that this matrix is identical with @t.
+        Check that this matrix is identical with @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 @t.
 
         @param t
             The matrix compared with this.
index 0d18095ce95f3c1562dd16f468abc5a3b3d389b2..e7d0a6df11084b4e494cca8b3cc86a4112e29185 100644 (file)
@@ -116,7 +116,7 @@ public:
 
     //@{
     /**
-        Check that this matrix is identical with @t.
+        Check that this matrix is identical with @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 @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;
 
 };
index d171f2666fdd64ff19a6954a7acb89ccfabd476c..2c0f8f74e74b11f1b3149168d8f82a2f8f2ed2aa 100644 (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.
     */
index 675c3ecbefef47fd1350cc1549e36c9b342639b6..23ad44c6b4342ce26bb9c975ffad01b2bef68dff 100644 (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();
index eae73a235b75a170922c7b0654e0d11cdc117e6a..d9a9c0dae79321473c0ba45117def7407ab32d7f 100644 (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()
index 3ae57ac40d5cbadab2a8b2389d8262f6f4303dcc..618d95a8ab2cc501952105d74cc2de0dad8a6056 100644 (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);
 
index 138e19c174507f7d6c9d8864080eeaec887d4a9f..217adb464ae37250675144a11aef83288184a6a0 100644 (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.
     */
index 1f167084376ecff1023ea07dc24a1316439c09cc..e34f200bac71b8e6d1f87de6571912964ef8dacc 100644 (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
index fb88948f5b38c19db1b89c505d056c943ff54867..b0ae879436bd6afd47b1d8714109b612b48ac32d 100644 (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
index 096bd36ca63b34050d9e4478b1ffe4e42a4116b5..c08d15d28d58f5521fd1bf6f9135fda3570d02fc 100644 (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,
index 1b3954f32181c71d1b0bde8415d95316afc8d874..5ec3a58a8c3340bc2f2ca0f7c349cf58f50feeeb 100644 (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
index c85bdcf9197837e059e8809b23462d7400b5e488..08bcaa1ca9a8cf933bcbde801e16c55884d33de7 100644 (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);
 
index 54d679506b277d8ff8a4e1f709484fe8304af6c2..6928a2d91d67d22c699a15077ec5abfee743efb5 100644 (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
index 5573a19b93e4f89b9e6a6234f04b1cc1f6f8e600..53fea4e6bb9a36a73f6e12451e3b40ada51fc6e6 100644 (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.
index 954f73fcd87c21d2bbc083d8f1c75656db985574..0164c8cbae352730ad9b654d25013748a2826503 100644 (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: