regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of'

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-10 15:24:38 +00:00
parent 3a65144e7c
commit e54c96f187
269 changed files with 2027 additions and 1553 deletions

View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: log.h
// Purpose: documentation for wxLogWindow class
// Purpose: interface of wxLogWindow
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -19,8 +19,7 @@
@library{wxbase}
@category{logging}
@seealso
wxLogTextCtrl
@see wxLogTextCtrl
*/
class wxLogWindow : public wxLogInterposer
{
@@ -79,6 +78,7 @@ public:
};
/**
@class wxLogInterposerTemp
@wxheader{log.h}
@@ -106,6 +106,7 @@ public:
};
/**
@class wxLogChain
@wxheader{log.h}
@@ -186,6 +187,7 @@ public:
};
/**
@class wxLogGui
@wxheader{log.h}
@@ -207,6 +209,7 @@ public:
};
/**
@class wxLogStream
@wxheader{log.h}
@@ -219,8 +222,7 @@ public:
@library{wxbase}
@category{logging}
@seealso
wxLogStderr, wxStreamToTextRedirector
@see wxLogStderr, wxStreamToTextRedirector
*/
class wxLogStream : public wxLog
{
@@ -233,6 +235,7 @@ public:
};
/**
@class wxLogStderr
@wxheader{log.h}
@@ -244,8 +247,7 @@ public:
@library{wxbase}
@category{logging}
@seealso
wxLogStream
@see wxLogStream
*/
class wxLogStderr : public wxLog
{
@@ -258,6 +260,7 @@ public:
};
/**
@class wxLogBuffer
@wxheader{log.h}
@@ -295,6 +298,7 @@ public:
};
/**
@class wxLogInterposer
@wxheader{log.h}
@@ -323,6 +327,7 @@ public:
};
/**
@class wxLogTextCtrl
@wxheader{log.h}
@@ -334,8 +339,7 @@ public:
@library{wxbase}
@category{logging}
@seealso
wxTextCtrl, wxStreamToTextRedirector
@see wxTextCtrl, wxStreamToTextRedirector
*/
class wxLogTextCtrl : public wxLog
{
@@ -348,6 +352,7 @@ public:
};
/**
@class wxLog
@wxheader{log.h}
@@ -371,15 +376,14 @@ public:
@library{wxcore}
@category{logging}
@seealso
wxLog::RemoveTraceMask, wxLog::GetTraceMasks
@see wxLog::RemoveTraceMask, wxLog::GetTraceMasks
*/
class wxLog
{
public:
/**
Add the @a mask to the list of allowed masks for
wxLogTrace.
wxLogTrace().
@see RemoveTraceMask(), GetTraceMasks()
*/
@@ -398,7 +402,7 @@ public:
without writing a new log target class (which, aside of being a matter of
several minutes, allows you to do anything you want).
The verbose messages are the trace messages which are not disabled in the
release mode and are generated by wxLogVerbose. They
release mode and are generated by wxLogVerbose(). They
are not normally shown to the user because they present little interest, but
may be activated, for example, in order to help the user find some program
problem.
@@ -406,7 +410,7 @@ public:
the (application global) @e trace mask. There are two ways to specify it:
either by using SetTraceMask() and
GetTraceMask() and using
wxLogTrace which takes an integer mask or by using
wxLogTrace() which takes an integer mask or by using
AddTraceMask() for string trace masks.
The difference between bit-wise and string trace masks is that a message using
integer trace mask will only be logged if all bits of the mask are set in the
@@ -423,7 +427,7 @@ public:
the preferred way of working with trace messages. The integer trace mask is
kept for compatibility and for additional (but very rarely needed) flexibility
only.
The standard trace masks are given in wxLogTrace
The standard trace masks are given in wxLogTrace()
documentation.
Finally, the @e wxLog::DoLog() function automatically prepends a time stamp
to all the messages. The format of the time stamp may be changed: it can be
@@ -575,7 +579,7 @@ public:
/**
Returns @true if the @a mask is one of allowed masks for
wxLogTrace.
wxLogTrace().
See also: AddTraceMask(),
RemoveTraceMask()
*/
@@ -614,7 +618,7 @@ public:
/**
Remove the @a mask from the list of allowed masks for
wxLogTrace.
wxLogTrace().
See also: AddTraceMask()
*/
static void RemoveTraceMask(const wxString& mask);
@@ -683,6 +687,7 @@ public:
};
/**
@class wxLogNull
@wxheader{log.h}
@@ -746,6 +751,7 @@ public:
};
// ============================================================================
// Global functions/macros
// ============================================================================
@@ -755,7 +761,7 @@ public:
call even before the application has been initialized or if it is currently in
some other strange state (for example, about to crash). Under Windows this
function shows a message box using a native dialog instead of
wxMessageBox (which might be unsafe to call), elsewhere
wxMessageBox() (which might be unsafe to call), elsewhere
it simply prints the message to the standard output using the title as prefix.
@param title
@@ -764,7 +770,7 @@ public:
@param text
The text to show to the user
@see wxLogFatalError
@see wxLogFatalError()
*/
void wxSafeShowMessage(const wxString& title,
const wxString& text);