From 1e24c2af0f22f9fff6922885eed7a1bef1b92112 Mon Sep 17 00:00:00 2001 From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= Date: Mon, 21 Apr 2008 10:34:23 +0000 Subject: [PATCH] @wxsince -> @since in Doxygen docs git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53281 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile_inc | 3 --- interface/app.h | 4 ++-- interface/bmpbuttn.h | 2 +- interface/choice.h | 6 +++--- interface/colour.h | 4 ++-- interface/cshelp.h | 2 +- interface/datetime.h | 2 +- interface/dc.h | 2 +- interface/dcmirror.h | 2 +- interface/dynlib.h | 2 +- interface/event.h | 2 +- interface/filefn.h | 2 +- interface/fs_mem.h | 2 +- interface/intl.h | 2 +- interface/listbox.h | 6 +++--- interface/listctrl.h | 4 ++-- interface/longlong.h | 2 +- interface/stattext.h | 2 +- interface/stdpaths.h | 8 ++++---- interface/strconv.h | 2 +- interface/stream.h | 2 +- interface/string.h | 4 ++-- interface/textctrl.h | 8 ++++---- interface/tokenzr.h | 2 +- interface/utils.h | 2 +- interface/window.h | 10 +++++----- 26 files changed, 43 insertions(+), 46 deletions(-) diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 5a35855af4..a493951ec2 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -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" -# 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="true" ALIASES += false="false" diff --git a/interface/app.h b/interface/app.h index 0800797a62..9577e621fa 100644 --- a/interface/app.h +++ b/interface/app.h @@ -83,7 +83,7 @@ public: 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; @@ -129,7 +129,7 @@ public: By default, returns the same string as GetVendorName(). - @wxsince{2.9.0} + @since 2.9.0 */ const wxString& GetVendorDisplayName() const; diff --git a/interface/bmpbuttn.h b/interface/bmpbuttn.h index 6d80e607b7..4c01ecd34e 100644 --- a/interface/bmpbuttn.h +++ b/interface/bmpbuttn.h @@ -207,7 +207,7 @@ public: /** 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. diff --git a/interface/choice.h b/interface/choice.h index a197296f39..db7d1c10bf 100644 --- a/interface/choice.h +++ b/interface/choice.h @@ -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. - @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; diff --git a/interface/colour.h b/interface/colour.h index d89e78fd1f..52bc2f28d1 100644 --- a/interface/colour.h +++ b/interface/colour.h @@ -94,7 +94,7 @@ public: 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); @@ -136,7 +136,7 @@ public: 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, diff --git a/interface/cshelp.h b/interface/cshelp.h index f462554593..258817b2b5 100644 --- a/interface/cshelp.h +++ b/interface/cshelp.h @@ -110,7 +110,7 @@ public: @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); diff --git a/interface/datetime.h b/interface/datetime.h index 770f981cbb..d964e6e599 100644 --- a/interface/datetime.h +++ b/interface/datetime.h @@ -419,7 +419,7 @@ public: 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() */ diff --git a/interface/dc.h b/interface/dc.h index 9b43844acd..509c734098 100644 --- a/interface/dc.h +++ b/interface/dc.h @@ -1071,7 +1071,7 @@ public: See wxMemoryDC for typical usage. - @wxsince{2.9.0} + @since 2.9.0 @see Blit(), wxMemoryDC, wxBitmap, wxMask */ diff --git a/interface/dcmirror.h b/interface/dcmirror.h index 4380e58a6b..d15af962f0 100644 --- a/interface/dcmirror.h +++ b/interface/dcmirror.h @@ -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. - @wxsince{2.5.0} + @since 2.5.0 @library{wxcore} @category{dc} diff --git a/interface/dynlib.h b/interface/dynlib.h index c38088c1c6..2ca0305177 100644 --- a/interface/dynlib.h +++ b/interface/dynlib.h @@ -290,7 +290,7 @@ public: 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; diff --git a/interface/event.h b/interface/event.h index 945be51cea..81ff87735c 100644 --- a/interface/event.h +++ b/interface/event.h @@ -1673,7 +1673,7 @@ public: 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; diff --git a/interface/filefn.h b/interface/filefn.h index 834b037ecb..152319c98d 100644 --- a/interface/filefn.h +++ b/interface/filefn.h @@ -119,7 +119,7 @@ public: 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. diff --git a/interface/fs_mem.h b/interface/fs_mem.h index b534e8af32..43c75996d1 100644 --- a/interface/fs_mem.h +++ b/interface/fs_mem.h @@ -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. - @wxsince{2.8.5} + @since 2.8.5 @see AddFile() */ diff --git a/interface/intl.h b/interface/intl.h index 2594f28187..3b77265194 100644 --- a/interface/intl.h +++ b/interface/intl.h @@ -364,7 +364,7 @@ public: wxLanguageInfo structure. See AddLanguage() for the wxLanguageInfo description. - @wxsince{2.7.1}. + @since 2.7.1. */ static bool IsAvailable(int lang); diff --git a/interface/listbox.h b/interface/listbox.h index 6c83521644..6c75a0bf92 100644 --- a/interface/listbox.h +++ b/interface/listbox.h @@ -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. - @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. + + @since 2.7.0 */ int HitTest(const wxPoint point) const; diff --git a/interface/listctrl.h b/interface/listctrl.h index 3ba6b6ba6f..48550a861a 100644 --- a/interface/listctrl.h +++ b/interface/listctrl.h @@ -442,7 +442,7 @@ public: @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; @@ -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. - @wxsince{2.8.4} + @since 2.8.4 */ bool SetItemPtrData(long item, wxUIntPtr data); diff --git a/interface/longlong.h b/interface/longlong.h index fc970ea8e6..e3eaef7ec6 100644 --- a/interface/longlong.h +++ b/interface/longlong.h @@ -134,7 +134,7 @@ public: /** 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); }; diff --git a/interface/stattext.h b/interface/stattext.h index dda0b92030..ff97b8f149 100644 --- a/interface/stattext.h +++ b/interface/stattext.h @@ -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. - @wxsince{2.6.2} + @since 2.6.2 */ void Wrap(int width); }; diff --git a/interface/stdpaths.h b/interface/stdpaths.h index 2ebd05cdb6..8c2769b3c3 100644 --- a/interface/stdpaths.h +++ b/interface/stdpaths.h @@ -81,7 +81,7 @@ public: - Windows: @c C:\\Documents @c and @c Settings\\username\\Documents - Mac: @c ~/Documents - @wxsince{2.7.0} + @since 2.7.0 */ 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. - @wxsince{2.7.0} + @since 2.7.0 */ 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 - @wxsince{2.7.0} + @since 2.7.0 @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. - @wxsince{2.7.2} + @since 2.7.2 */ wxString GetTempDir() const; diff --git a/interface/strconv.h b/interface/strconv.h index 578b4ac890..834401a506 100644 --- a/interface/strconv.h +++ b/interface/strconv.h @@ -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. - @wxsince{2.8.2} + @since 2.8.2 */ bool IsOk() const; diff --git a/interface/stream.h b/interface/stream.h index db8f227efe..4957165e01 100644 --- a/interface/stream.h +++ b/interface/stream.h @@ -725,7 +725,7 @@ public: (this is always the case for socket streams for example), returns @c wxInvalidOffset. - @wxsince{2.5.4} + @since 2.5.4 */ wxFileOffset GetLength() const; diff --git a/interface/string.h b/interface/string.h index c44f1a059c..bae298ac93 100644 --- a/interface/string.h +++ b/interface/string.h @@ -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. - @wxsince{2.8.4} + @since 2.8.4 @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. - @wxsince{2.8.4} + @since 2.8.4 @see wxString::From8BitData */ diff --git a/interface/textctrl.h b/interface/textctrl.h index e8384c07b9..1b5ff11567 100644 --- a/interface/textctrl.h +++ b/interface/textctrl.h @@ -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. - @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 @@ -785,7 +785,7 @@ public: 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 @@ -833,7 +833,7 @@ public: 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 @@ -1026,7 +1026,7 @@ public: @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; diff --git a/interface/tokenzr.h b/interface/tokenzr.h index b9db6a1826..782f3c65cf 100644 --- a/interface/tokenzr.h +++ b/interface/tokenzr.h @@ -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. - @wxsince{2.7.0} + @since 2.7.0 */ wxChar GetLastDelimiter(); diff --git a/interface/utils.h b/interface/utils.h index ff2a1f8ec8..d5334c64c0 100644 --- a/interface/utils.h +++ b/interface/utils.h @@ -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. - @wxsince{2.9.0} + @since 2.9.0 @header{wx/utils.h} */ diff --git a/interface/window.h b/interface/window.h index 0ecce78b88..329d483714 100644 --- a/interface/window.h +++ b/interface/window.h @@ -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. - @wxsince{2.9.0} + @since 2.9.0 @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. - @wxsince{2.8.8} + @since 2.8.8 @see GetPrevSibling() */ @@ -1008,7 +1008,7 @@ public: @NULL if this window is the first child. - @wxsince{2.8.8} + @since 2.8.8 @see GetNextSibling() */ @@ -1261,7 +1261,7 @@ public: ShowWithEffect(), please see their description there. - @wxsince{2.9.0} + @since 2.9.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. - @wxsince{2.9.0} + @since 2.9.0 @see HideWithEffect() */ -- 2.45.2