]> git.saurik.com Git - wxWidgets.git/commitdiff
@wxsince -> @since in Doxygen docs
authorVáclav Slavík <vslavik@fastmail.fm>
Mon, 21 Apr 2008 10:34:23 +0000 (10:34 +0000)
committerVáclav Slavík <vslavik@fastmail.fm>
Mon, 21 Apr 2008 10:34:23 +0000 (10:34 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53281 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

26 files changed:
docs/doxygen/Doxyfile_inc
interface/app.h
interface/bmpbuttn.h
interface/choice.h
interface/colour.h
interface/cshelp.h
interface/datetime.h
interface/dc.h
interface/dcmirror.h
interface/dynlib.h
interface/event.h
interface/filefn.h
interface/fs_mem.h
interface/intl.h
interface/listbox.h
interface/listctrl.h
interface/longlong.h
interface/stattext.h
interface/stdpaths.h
interface/strconv.h
interface/stream.h
interface/string.h
interface/textctrl.h
interface/tokenzr.h
interface/utils.h
interface/window.h

index 5a35855af426b35a3d0b303353a8dc131d7cac57..a493951ec23e4f1becae40d8bcbc5e2279f4b77a 100644 (file)
@@ -101,9 +101,6 @@ ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
 #            and not twice as the \headerfile command requires:
 ALIASES += wxheader{1}="\headerfile \1 wx/\1"
 
 #            and not twice as the \headerfile command requires:
 ALIASES += wxheader{1}="\headerfile \1 wx/\1"
 
-# the following alias avoids to repeat lots of times the same statement:
-ALIASES += wxsince{1}="\since This feature is available in wxWidgets version \1 or higher."
-
 # some formatting aliases
 ALIASES += true="<span class='literal'>true</span>"
 ALIASES += false="<span class='literal'>false</span>"
 # some formatting aliases
 ALIASES += true="<span class='literal'>true</span>"
 ALIASES += false="<span class='literal'>false</span>"
index 0800797a62f4ca7f702c5f945b420e04393b57ac..9577e621fa89bc3dce3ca5520919e824375b80a1 100644 (file)
@@ -83,7 +83,7 @@ public:
         e.g. for the file names or configuration file keys.
         By default, returns the same string as GetAppName().
 
         e.g. for the file names or configuration file keys.
         By default, returns the same string as GetAppName().
 
-        @wxsince{2.9.0}
+        @since 2.9.0
     */
     wxString GetAppDisplayName() const;
 
     */
     wxString GetAppDisplayName() const;
 
@@ -129,7 +129,7 @@ public:
 
         By default, returns the same string as GetVendorName().
 
 
         By default, returns the same string as GetVendorName().
 
-        @wxsince{2.9.0}
+        @since 2.9.0
     */
     const wxString& GetVendorDisplayName() const;
 
     */
     const wxString& GetVendorDisplayName() const;
 
index 6d80e607b7ca72578cd141d0120adb2dbb854fd3..4c01ecd34e56735e5431f09f957893c7f60b4dca 100644 (file)
@@ -207,7 +207,7 @@ public:
     /**
         Sets the bitmap to be shown when the mouse is over the button.
 
     /**
         Sets the bitmap to be shown when the mouse is over the button.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
 
         The hover bitmap is currently only supported in wxMSW.
 
 
         The hover bitmap is currently only supported in wxMSW.
 
index a197296f39174c8fc1912ba5afce9e1e3c1367a5..db7d1c10bf7c582bab35790b9108b9e703455f80 100644 (file)
@@ -130,9 +130,9 @@ public:
         currently selected item in it. When it is not shown, its result is the
         same as for the other function.
 
         currently selected item in it. When it is not shown, its result is the
         same as for the other function.
 
-        @wxsince{2.6.2} (before this version,
-                         wxControlWithItems::GetSelection() itself behaved like
-                         this).
+        @since 2.6.2.
+               In older versions, wxControlWithItems::GetSelection() itself
+               behaved like this.
     */
     int GetCurrentSelection() const;
 
     */
     int GetCurrentSelection() const;
 
index d89e78fd1f6d3a37abe4bc98159b912d71239999..52bc2f28d1c2e83cec0747ed0299a006d24d5201 100644 (file)
@@ -94,7 +94,7 @@ public:
         wxC2S_CSS_SYNTAX (which is the only one supporting alpha) is not
         specified in flags.
 
         wxC2S_CSS_SYNTAX (which is the only one supporting alpha) is not
         specified in flags.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     wxString GetAsString(long flags);
 
     */
     wxString GetAsString(long flags);
 
@@ -136,7 +136,7 @@ public:
 
         Returns @true if the conversion was successful, @false otherwise.
 
 
         Returns @true if the conversion was successful, @false otherwise.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     void Set(unsigned char red, unsigned char green,
              unsigned char blue,
     */
     void Set(unsigned char red, unsigned char green,
              unsigned char blue,
index f4625545937de647670b7c4e7905cacd0588e7f3..258817b2b5391a08353a361964b622cf005c6caf 100644 (file)
@@ -110,7 +110,7 @@ public:
         @returns @true if help was shown, or @false if no help was available
                  for this window.
 
         @returns @true if help was shown, or @false if no help was available
                  for this window.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     virtual bool ShowHelpAtPoint(wxWindowBase* window, const wxPoint point,
                                    wxHelpEvent::Origin origin);
     */
     virtual bool ShowHelpAtPoint(wxWindowBase* window, const wxPoint point,
                                    wxHelpEvent::Origin origin);
index 770f981cbbbd1c819db2f7ec0d36d06d2c1c0d3d..d964e6e5999da8d0cecfb7711c437228b43ecb61 100644 (file)
@@ -419,7 +419,7 @@ public:
         Returns the object having the same date component as this one but time
         of 00:00:00.
 
         Returns the object having the same date component as this one but time
         of 00:00:00.
 
-        @wxsince{2.8.2}
+        @since 2.8.2
 
         @see ResetTime()
     */
 
         @see ResetTime()
     */
index 9b43844acd657a8eb8b3e7e626991a5c5632ebcc..509c7340984a1573de4a7dad5149a74e24844434 100644 (file)
@@ -1071,7 +1071,7 @@ public:
 
         See wxMemoryDC for typical usage.
 
 
         See wxMemoryDC for typical usage.
 
-        @wxsince{2.9.0}
+        @since 2.9.0
 
         @see Blit(), wxMemoryDC, wxBitmap, wxMask
     */
 
         @see Blit(), wxMemoryDC, wxBitmap, wxMask
     */
index 4380e58a6b6f8541cd5452689ef1faa06ad84723..d15af962f04929ff0dc9b646995b21d3728c0451 100644 (file)
@@ -16,7 +16,7 @@
     makes it possible to reuse the same code to draw a figure and its mirror --
     i.e. reflection related to the diagonal line x == y.
 
     makes it possible to reuse the same code to draw a figure and its mirror --
     i.e. reflection related to the diagonal line x == y.
 
-    @wxsince{2.5.0}
+    @since 2.5.0
 
     @library{wxcore}
     @category{dc}
 
     @library{wxcore}
     @category{dc}
index c38088c1c6080e9fa5580c576746f78517aabb12..2ca03051776d9416f7752adda4de7c2d90660243 100644 (file)
@@ -290,7 +290,7 @@ public:
         library, @false otherwise. Unlike GetSymbol(),
         this function doesn't log an error message if the symbol is not found.
 
         library, @false otherwise. Unlike GetSymbol(),
         this function doesn't log an error message if the symbol is not found.
 
-        @wxsince{2.5.4}
+        @since 2.5.4
     */
     bool HasSymbol(const wxString& name) const;
 
     */
     bool HasSymbol(const wxString& name) const;
 
index 945be51ceabfa575447ba1ad0ea4428b00211ce5..81ff87735c0d112dacd9d8ca92ec3d40af551ba2 100644 (file)
@@ -1673,7 +1673,7 @@ public:
         other platforms (you can still distinguish simple clicks from double-clicks as
         they generate different kinds of events however).
 
         other platforms (you can still distinguish simple clicks from double-clicks as
         they generate different kinds of events however).
 
-        @wxsince{2.9.0}
+        @since 2.9.0
     */
     int GetClickCount() const;
 
     */
     int GetClickCount() const;
 
index 834b037ecbc9fae9b674e8238b05e43aeea6a279..152319c98d98f5b990e43dc07d27e36d6604c368 100644 (file)
@@ -119,7 +119,7 @@ public:
     and @a free parameters may be @NULL if the corresponding information is not
     needed.
 
     and @a free parameters may be @NULL if the corresponding information is not
     needed.
 
-    @wxsince{2.3.2}
+    @since 2.3.2
 
     @note The generic Unix implementation depends on the system having the
           @c statfs() or @c statvfs() function.
 
     @note The generic Unix implementation depends on the system having the
           @c statfs() or @c statvfs() function.
index b534e8af32b0b303e10280d04b285b9812390801..43c75996d1336bd781e4c1e608214d3020fa2b16 100644 (file)
@@ -97,7 +97,7 @@ public:
         specify added file's MIME type. This version should be used whenever you know
         the MIME type, because it makes accessing the files faster.
 
         specify added file's MIME type. This version should be used whenever you know
         the MIME type, because it makes accessing the files faster.
 
-        @wxsince{2.8.5}
+        @since 2.8.5
 
         @see AddFile()
     */
 
         @see AddFile()
     */
index 2594f281879f3a56a0d5c9063c305394d9aa665a..3b77265194780e316225aed1a9598026f3e03e5b 100644 (file)
@@ -364,7 +364,7 @@ public:
         wxLanguageInfo structure. See AddLanguage() for
         the wxLanguageInfo description.
 
         wxLanguageInfo structure. See AddLanguage() for
         the wxLanguageInfo description.
 
-        @wxsince{2.7.1}.
+        @since 2.7.1.
     */
     static bool IsAvailable(int lang);
 
     */
     static bool IsAvailable(int lang);
 
index 6c8352164445d80207a44514f6a1aa7b69359fca..6c75a0bf921567ef091cb206093edd135f66e590 100644 (file)
@@ -163,15 +163,15 @@ public:
         Returns the item located at @e point, or @c wxNOT_FOUND if there
         is no item located at @e point.
 
         Returns the item located at @e point, or @c wxNOT_FOUND if there
         is no item located at @e point.
 
-        @wxsince{2.7.0}. It is currently implemented
-        for wxMSW, wxMac and wxGTK2
-        ports.
+        It is currently implemented for wxMSW, wxMac and wxGTK2 ports.
 
         @param point
             Point of item (in client coordinates) to obtain
 
         @returns Item located at point, or wxNOT_FOUND if unimplemented or the
                  item does not exist.
 
         @param point
             Point of item (in client coordinates) to obtain
 
         @returns Item located at point, or wxNOT_FOUND if unimplemented or the
                  item does not exist.
+
+        @since 2.7.0
     */
     int HitTest(const wxPoint point) const;
 
     */
     int HitTest(const wxPoint point) const;
 
index 3ba6b6ba6f80ec275701725bcfd6c2e7f77cfe2b..48550a861a19fdde2c0f028b7b0e1dc350c262b2 100644 (file)
@@ -442,7 +442,7 @@ public:
         @a code can be one of @c wxLIST_RECT_BOUNDS,
         @c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL.
 
         @a code can be one of @c wxLIST_RECT_BOUNDS,
         @c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     bool GetSubItemRect(long item, long subItem, wxRect& rect,
                         int code = wxLIST_RECT_BOUNDS) const;
     */
     bool GetSubItemRect(long item, long subItem, wxRect& rect,
                         int code = wxLIST_RECT_BOUNDS) const;
@@ -875,7 +875,7 @@ The m_stateMask and m_state members take flags from the following:
         guaranteed to be large enough to be able to contain all integer types and
         pointers.
 
         guaranteed to be large enough to be able to contain all integer types and
         pointers.
 
-        @wxsince{2.8.4}
+        @since 2.8.4
     */
     bool SetItemPtrData(long item, wxUIntPtr data);
 
     */
     bool SetItemPtrData(long item, wxUIntPtr data);
 
index fc970ea8e6044632a5451b90cf0d6f2f1f93900c..e3eaef7ec65814e4db6f7e0229149b4fc81d2111 100644 (file)
@@ -134,7 +134,7 @@ public:
     /**
         Assignment operator from unsigned long long. The sign bit will be copied too.
 
     /**
         Assignment operator from unsigned long long. The sign bit will be copied too.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     wxLongLong& operator operator=(const wxULongLong& ll);
 };
     */
     wxLongLong& operator operator=(const wxULongLong& ll);
 };
index dda0b9203008319ac058c3b39c4f3c94845fd732..ff97b8f149e2c9081cd2c844fb5c14624573c2ba 100644 (file)
@@ -203,7 +203,7 @@ public:
         boundaries so it might not be the case if words are too long). If @e width
         is negative, no wrapping is done.
 
         boundaries so it might not be the case if words are too long). If @e width
         is negative, no wrapping is done.
 
-        @wxsince{2.6.2}
+        @since 2.6.2
     */
     void Wrap(int width);
 };
     */
     void Wrap(int width);
 };
index 2ebd05cdb6f71e2d4236326585c85216c537cbad..8c2769b3c37652eae6b905592be2d649c645219e 100644 (file)
@@ -81,7 +81,7 @@ public:
              - Windows: @c C:\\Documents @c and @c Settings\\username\\Documents
              - Mac: @c ~/Documents
 
              - Windows: @c C:\\Documents @c and @c Settings\\username\\Documents
              - Mac: @c ~/Documents
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     wxString GetDocumentsDir() const;
 
     */
     wxString GetDocumentsDir() const;
 
@@ -120,7 +120,7 @@ public:
         different for message catalog category under Unix where it returns the standard
         @c prefix/share/locale/lang/LC_MESSAGES directory.
 
         different for message catalog category under Unix where it returns the standard
         @c prefix/share/locale/lang/LC_MESSAGES directory.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     wxString GetLocalizedResourcesDir(const wxString& lang,
                                       ResourceCat category = ResourceCat_None) const;
     */
     wxString GetLocalizedResourcesDir(const wxString& lang,
                                       ResourceCat category = ResourceCat_None) const;
@@ -147,7 +147,7 @@ public:
              - Windows: the directory where the executable file is located
              - Mac: @c appname.app/Contents/Resources bundle subdirectory
 
              - Windows: the directory where the executable file is located
              - Mac: @c appname.app/Contents/Resources bundle subdirectory
 
-        @wxsince{2.7.0}
+        @since 2.7.0
 
         @see GetLocalizedResourcesDir()
     */
 
         @see GetLocalizedResourcesDir()
     */
@@ -159,7 +159,7 @@ public:
         it is best to use wxFileName::CreateTempFileName for correct behaviour when
         multiple processes are attempting to create temporary files.
 
         it is best to use wxFileName::CreateTempFileName for correct behaviour when
         multiple processes are attempting to create temporary files.
 
-        @wxsince{2.7.2}
+        @since 2.7.2
     */
     wxString GetTempDir() const;
 
     */
     wxString GetTempDir() const;
 
index 578b4ac89049e6f65243be8087f4bcb6e88559df..834401a506a53614733701b26d81f1739ef95866 100644 (file)
@@ -142,7 +142,7 @@ public:
         Note this does not mean that a given string will be correctly converted.
         A malformed string may still make conversion functions return @c wxCONV_FAILED.
 
         Note this does not mean that a given string will be correctly converted.
         A malformed string may still make conversion functions return @c wxCONV_FAILED.
 
-        @wxsince{2.8.2}
+        @since 2.8.2
     */
     bool IsOk() const;
 
     */
     bool IsOk() const;
 
index db8f227efee187de013142b6363ff411afe90c81..4957165e010d95523815881d147198519fb46118 100644 (file)
@@ -725,7 +725,7 @@ public:
         (this is always the case for socket streams for example), returns
         @c wxInvalidOffset.
 
         (this is always the case for socket streams for example), returns
         @c wxInvalidOffset.
 
-        @wxsince{2.5.4}
+        @since 2.5.4
     */
     wxFileOffset GetLength() const;
 
     */
     wxFileOffset GetLength() const;
 
index c44f1a059c3507bf4682b56221dd2fc3bf032e60..bae298ac935cf385fcb8b98895460353abac6fce 100644 (file)
@@ -459,7 +459,7 @@ public:
         without @a len parameter takes NUL-terminated data.
         This is a convenience method useful when storing binary data in wxString.
 
         without @a len parameter takes NUL-terminated data.
         This is a convenience method useful when storing binary data in wxString.
 
-        @wxsince{2.8.4}
+        @since 2.8.4
 
         @see wxString::To8BitData
     */
 
         @see wxString::To8BitData
     */
@@ -817,7 +817,7 @@ public:
         a wxCharBuffer (Unicode builds only).
         This is a convenience method useful when storing binary data in wxString.
 
         a wxCharBuffer (Unicode builds only).
         This is a convenience method useful when storing binary data in wxString.
 
-        @wxsince{2.8.4}
+        @since 2.8.4
 
         @see wxString::From8BitData
     */
 
         @see wxString::From8BitData
     */
index e8384c07b9e6dea4713e5f4810ee6113e2e1c16a..1b5ff11567cd6c1afc1bed789c5921834c1fac79 100644 (file)
@@ -769,7 +769,7 @@ public:
         Notice that currently this function is only implemented in wxGTK2 and wxMSW
         ports and does nothing under the other platforms.
 
         Notice that currently this function is only implemented in wxGTK2 and wxMSW
         ports and does nothing under the other platforms.
 
-        @wxsince{2.9.0}
+        @since 2.9.0
 
         @returns @true if the auto-completion was enabled or @false if the
                  operation failed, typically because auto-completion is
 
         @returns @true if the auto-completion was enabled or @false if the
                  operation failed, typically because auto-completion is
@@ -785,7 +785,7 @@ public:
         Notice that currently this function is only implemented in wxGTK2 port and does
         nothing under the other platforms.
 
         Notice that currently this function is only implemented in wxGTK2 port and does
         nothing under the other platforms.
 
-        @wxsince{2.9.0}
+        @since 2.9.0
 
         @returns @true if the auto-completion was enabled or @false if the
                  operation failed, typically because auto-completion is
 
         @returns @true if the auto-completion was enabled or @false if the
                  operation failed, typically because auto-completion is
@@ -833,7 +833,7 @@ public:
         This is the only difference with SetValue().
         See @ref overview_progevent "this topic" for more information.
 
         This is the only difference with SetValue().
         See @ref overview_progevent "this topic" for more information.
 
-        @wxsince{2.7.1}
+        @since 2.7.1
 
         @param value
             The new value to set. It may contain newline characters if the text control
 
         @param value
             The new value to set. It may contain newline characters if the text control
@@ -1026,7 +1026,7 @@ public:
         @c GetValue().empty() but can be much more efficient for the multiline
         controls containing big amounts of text.
 
         @c GetValue().empty() but can be much more efficient for the multiline
         controls containing big amounts of text.
 
-        @wxsince{2.7.1}
+        @since 2.7.1
     */
     bool IsEmpty() const;
 
     */
     bool IsEmpty() const;
 
index b9db6a1826c7d5a428e8eb06785ad2650bea6c6c..782f3c65cffe31d1854f824b796c980c65337f4f 100644 (file)
@@ -130,7 +130,7 @@ public:
         there had been no calls to this function yet or if it returned the trailing
         empty token in @c wxTOKEN_RET_EMPTY_ALL mode.
 
         there had been no calls to this function yet or if it returned the trailing
         empty token in @c wxTOKEN_RET_EMPTY_ALL mode.
 
-        @wxsince{2.7.0}
+        @since 2.7.0
     */
     wxChar GetLastDelimiter();
 
     */
     wxChar GetLastDelimiter();
 
index ff2a1f8ec895f87688ae430773f352e6bbcd295e..d5334c64c08353997d6d2780f0b375d9e323aa2b 100644 (file)
@@ -189,7 +189,7 @@ void wxBell();
     and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which
     doesn't otherwise handle this event.
 
     and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which
     doesn't otherwise handle this event.
 
-    @wxsince{2.9.0}
+    @since 2.9.0
 
     @header{wx/utils.h}
 */
 
     @header{wx/utils.h}
 */
index 0ecce78b8839abe35c3bef0dbbd19e60eda288ff..329d483714112e27b994d0baf2db8e801aa933ce 100644 (file)
@@ -212,7 +212,7 @@ public:
         Call this function to force one or both scrollbars to be always shown, even if
         the window is big enough to show its entire contents without scrolling.
 
         Call this function to force one or both scrollbars to be always shown, even if
         the window is big enough to show its entire contents without scrolling.
 
-        @wxsince{2.9.0}
+        @since 2.9.0
 
         @param hflag
             Whether the horizontal scroll bar should always be visible.
 
         @param hflag
             Whether the horizontal scroll bar should always be visible.
@@ -951,7 +951,7 @@ public:
         Returns the next window after this one among the parent children or @NULL if
         this window is the last child.
 
         Returns the next window after this one among the parent children or @NULL if
         this window is the last child.
 
-        @wxsince{2.8.8}
+        @since 2.8.8
 
         @see GetPrevSibling()
     */
 
         @see GetPrevSibling()
     */
@@ -1008,7 +1008,7 @@ public:
         @NULL if
         this window is the first child.
 
         @NULL if
         this window is the first child.
 
-        @wxsince{2.8.8}
+        @since 2.8.8
 
         @see GetNextSibling()
     */
 
         @see GetNextSibling()
     */
@@ -1261,7 +1261,7 @@ public:
         ShowWithEffect(), please see their
         description there.
 
         ShowWithEffect(), please see their
         description there.
 
-        @wxsince{2.9.0}
+        @since 2.9.0
     */
     virtual bool HideWithEffect(wxShowEffect effect,
                                 unsigned timeout = 0,
     */
     virtual bool HideWithEffect(wxShowEffect effect,
                                 unsigned timeout = 0,
@@ -2484,7 +2484,7 @@ public:
         Currently this function is only implemented in wxMSW and does the same thing as
         Show() in the other ports.
 
         Currently this function is only implemented in wxMSW and does the same thing as
         Show() in the other ports.
 
-        @wxsince{2.9.0}
+        @since 2.9.0
 
         @see HideWithEffect()
     */
 
         @see HideWithEffect()
     */