@wxsince -> @since in Doxygen docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53281 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2008-04-21 10:34:23 +00:00
parent 687537119b
commit 1e24c2af0f
26 changed files with 43 additions and 46 deletions

View File

@@ -101,9 +101,6 @@ ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
# and not twice as the \headerfile command requires: # and not twice as the \headerfile command requires:
ALIASES += wxheader{1}="\headerfile \1 wx/\1" 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 # some formatting aliases
ALIASES += true="<span class='literal'>true</span>" ALIASES += true="<span class='literal'>true</span>"
ALIASES += false="<span class='literal'>false</span>" ALIASES += false="<span class='literal'>false</span>"

View File

@@ -83,7 +83,7 @@ public:
e.g. for the file names or configuration file keys. e.g. for the file names or configuration file keys.
By default, returns the same string as GetAppName(). 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;

View 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.

View File

@@ -130,9 +130,9 @@ public:
currently selected item in it. When it is not shown, its result is the currently selected item in it. When it is not shown, its result is the
same as for the other function. same as for the other function.
@wxsince{2.6.2} (before this version, @since 2.6.2.
wxControlWithItems::GetSelection() itself behaved like In older versions, wxControlWithItems::GetSelection() itself
this). behaved like this.
*/ */
int GetCurrentSelection() const; int GetCurrentSelection() const;

View File

@@ -94,7 +94,7 @@ public:
wxC2S_CSS_SYNTAX (which is the only one supporting alpha) is not wxC2S_CSS_SYNTAX (which is the only one supporting alpha) is not
specified in flags. 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, void Set(unsigned char red, unsigned char green,
unsigned char blue, unsigned char blue,

View File

@@ -110,7 +110,7 @@ public:
@returns @true if help was shown, or @false if no help was available @returns @true if help was shown, or @false if no help was available
for this window. for this window.
@wxsince{2.7.0} @since 2.7.0
*/ */
virtual bool ShowHelpAtPoint(wxWindowBase* window, const wxPoint point, virtual bool ShowHelpAtPoint(wxWindowBase* window, const wxPoint point,
wxHelpEvent::Origin origin); wxHelpEvent::Origin origin);

View File

@@ -419,7 +419,7 @@ public:
Returns the object having the same date component as this one but time Returns the object having the same date component as this one but time
of 00:00:00. of 00:00:00.
@wxsince{2.8.2} @since 2.8.2
@see ResetTime() @see ResetTime()
*/ */

View 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
*/ */

View File

@@ -16,7 +16,7 @@
makes it possible to reuse the same code to draw a figure and its mirror -- 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. i.e. reflection related to the diagonal line x == y.
@wxsince{2.5.0} @since 2.5.0
@library{wxcore} @library{wxcore}
@category{dc} @category{dc}

View File

@@ -290,7 +290,7 @@ public:
library, @false otherwise. Unlike GetSymbol(), library, @false otherwise. Unlike GetSymbol(),
this function doesn't log an error message if the symbol is not found. 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;

View File

@@ -1673,7 +1673,7 @@ public:
other platforms (you can still distinguish simple clicks from double-clicks as other platforms (you can still distinguish simple clicks from double-clicks as
they generate different kinds of events however). they generate different kinds of events however).
@wxsince{2.9.0} @since 2.9.0
*/ */
int GetClickCount() const; int GetClickCount() const;

View File

@@ -119,7 +119,7 @@ public:
and @a free parameters may be @NULL if the corresponding information is not and @a free parameters may be @NULL if the corresponding information is not
needed. needed.
@wxsince{2.3.2} @since 2.3.2
@note The generic Unix implementation depends on the system having the @note The generic Unix implementation depends on the system having the
@c statfs() or @c statvfs() function. @c statfs() or @c statvfs() function.

View File

@@ -97,7 +97,7 @@ public:
specify added file's MIME type. This version should be used whenever you know specify added file's MIME type. This version should be used whenever you know
the MIME type, because it makes accessing the files faster. the MIME type, because it makes accessing the files faster.
@wxsince{2.8.5} @since 2.8.5
@see AddFile() @see AddFile()
*/ */

View File

@@ -364,7 +364,7 @@ public:
wxLanguageInfo structure. See AddLanguage() for wxLanguageInfo structure. See AddLanguage() for
the wxLanguageInfo description. the wxLanguageInfo description.
@wxsince{2.7.1}. @since 2.7.1.
*/ */
static bool IsAvailable(int lang); static bool IsAvailable(int lang);

View File

@@ -163,15 +163,15 @@ public:
Returns the item located at @e point, or @c wxNOT_FOUND if there Returns the item located at @e point, or @c wxNOT_FOUND if there
is no item located at @e point. is no item located at @e point.
@wxsince{2.7.0}. It is currently implemented It is currently implemented for wxMSW, wxMac and wxGTK2 ports.
for wxMSW, wxMac and wxGTK2
ports.
@param point @param point
Point of item (in client coordinates) to obtain Point of item (in client coordinates) to obtain
@returns Item located at point, or wxNOT_FOUND if unimplemented or the @returns Item located at point, or wxNOT_FOUND if unimplemented or the
item does not exist. item does not exist.
@since 2.7.0
*/ */
int HitTest(const wxPoint point) const; int HitTest(const wxPoint point) const;

View File

@@ -442,7 +442,7 @@ public:
@a code can be one of @c wxLIST_RECT_BOUNDS, @a code can be one of @c wxLIST_RECT_BOUNDS,
@c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL. @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, bool GetSubItemRect(long item, long subItem, wxRect& rect,
int code = wxLIST_RECT_BOUNDS) const; 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 guaranteed to be large enough to be able to contain all integer types and
pointers. pointers.
@wxsince{2.8.4} @since 2.8.4
*/ */
bool SetItemPtrData(long item, wxUIntPtr data); bool SetItemPtrData(long item, wxUIntPtr data);

View 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);
}; };

View File

@@ -203,7 +203,7 @@ public:
boundaries so it might not be the case if words are too long). If @e width boundaries so it might not be the case if words are too long). If @e width
is negative, no wrapping is done. is negative, no wrapping is done.
@wxsince{2.6.2} @since 2.6.2
*/ */
void Wrap(int width); void Wrap(int width);
}; };

View File

@@ -81,7 +81,7 @@ public:
- Windows: @c C:\\Documents @c and @c Settings\\username\\Documents - Windows: @c C:\\Documents @c and @c Settings\\username\\Documents
- Mac: @c ~/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 different for message catalog category under Unix where it returns the standard
@c prefix/share/locale/lang/LC_MESSAGES directory. @c prefix/share/locale/lang/LC_MESSAGES directory.
@wxsince{2.7.0} @since 2.7.0
*/ */
wxString GetLocalizedResourcesDir(const wxString& lang, wxString GetLocalizedResourcesDir(const wxString& lang,
ResourceCat category = ResourceCat_None) const; ResourceCat category = ResourceCat_None) const;
@@ -147,7 +147,7 @@ public:
- Windows: the directory where the executable file is located - Windows: the directory where the executable file is located
- Mac: @c appname.app/Contents/Resources bundle subdirectory - 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 it is best to use wxFileName::CreateTempFileName for correct behaviour when
multiple processes are attempting to create temporary files. multiple processes are attempting to create temporary files.
@wxsince{2.7.2} @since 2.7.2
*/ */
wxString GetTempDir() const; wxString GetTempDir() const;

View File

@@ -142,7 +142,7 @@ public:
Note this does not mean that a given string will be correctly converted. 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. 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;

View File

@@ -725,7 +725,7 @@ public:
(this is always the case for socket streams for example), returns (this is always the case for socket streams for example), returns
@c wxInvalidOffset. @c wxInvalidOffset.
@wxsince{2.5.4} @since 2.5.4
*/ */
wxFileOffset GetLength() const; wxFileOffset GetLength() const;

View File

@@ -459,7 +459,7 @@ public:
without @a len parameter takes NUL-terminated data. without @a len parameter takes NUL-terminated data.
This is a convenience method useful when storing binary data in wxString. 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). a wxCharBuffer (Unicode builds only).
This is a convenience method useful when storing binary data in wxString. 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
*/ */

View File

@@ -769,7 +769,7 @@ public:
Notice that currently this function is only implemented in wxGTK2 and wxMSW Notice that currently this function is only implemented in wxGTK2 and wxMSW
ports and does nothing under the other platforms. 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 @returns @true if the auto-completion was enabled or @false if the
operation failed, typically because auto-completion is 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 Notice that currently this function is only implemented in wxGTK2 port and does
nothing under the other platforms. 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 @returns @true if the auto-completion was enabled or @false if the
operation failed, typically because auto-completion is operation failed, typically because auto-completion is
@@ -833,7 +833,7 @@ public:
This is the only difference with SetValue(). This is the only difference with SetValue().
See @ref overview_progevent "this topic" for more information. See @ref overview_progevent "this topic" for more information.
@wxsince{2.7.1} @since 2.7.1
@param value @param value
The new value to set. It may contain newline characters if the text control 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 @c GetValue().empty() but can be much more efficient for the multiline
controls containing big amounts of text. controls containing big amounts of text.
@wxsince{2.7.1} @since 2.7.1
*/ */
bool IsEmpty() const; bool IsEmpty() const;

View File

@@ -130,7 +130,7 @@ public:
there had been no calls to this function yet or if it returned the trailing there had been no calls to this function yet or if it returned the trailing
empty token in @c wxTOKEN_RET_EMPTY_ALL mode. empty token in @c wxTOKEN_RET_EMPTY_ALL mode.
@wxsince{2.7.0} @since 2.7.0
*/ */
wxChar GetLastDelimiter(); wxChar GetLastDelimiter();

View File

@@ -189,7 +189,7 @@ void wxBell();
and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which
doesn't otherwise handle this event. doesn't otherwise handle this event.
@wxsince{2.9.0} @since 2.9.0
@header{wx/utils.h} @header{wx/utils.h}
*/ */

View File

@@ -212,7 +212,7 @@ public:
Call this function to force one or both scrollbars to be always shown, even if 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. the window is big enough to show its entire contents without scrolling.
@wxsince{2.9.0} @since 2.9.0
@param hflag @param hflag
Whether the horizontal scroll bar should always be visible. 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 Returns the next window after this one among the parent children or @NULL if
this window is the last child. 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 @NULL if
this window is the first child. 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 ShowWithEffect(), please see their
description there. description there.
@wxsince{2.9.0} @since 2.9.0
*/ */
virtual bool HideWithEffect(wxShowEffect effect, virtual bool HideWithEffect(wxShowEffect effect,
unsigned timeout = 0, unsigned timeout = 0,
@@ -2484,7 +2484,7 @@ public:
Currently this function is only implemented in wxMSW and does the same thing as Currently this function is only implemented in wxMSW and does the same thing as
Show() in the other ports. Show() in the other ports.
@wxsince{2.9.0} @since 2.9.0
@see HideWithEffect() @see HideWithEffect()
*/ */