document the main event table macros, wxEventType, wxNewEventType; create a new group...

[wxWidgets.git] / interface / wx / log.h

diff --git a/interface/wx/log.h b/interface/wx/log.h
index 0f874d9da4043c29af0716ce110d69d2165bd8b4..0c0dd86c9ccb21d89a0131279960ea8369e2e9ab 100644 (file)
--- a/interface/wx/log.h
+++ b/interface/wx/log.h
@@ -396,7 +396,7 @@ public:
         Constructs a log target which sends all the log messages to the given
         output stream. If it is @NULL, the messages are sent to @c cerr.
     */
         Constructs a log target which sends all the log messages to the given
         output stream. If it is @NULL, the messages are sent to @c cerr.
     */

-    wxLogStream(std::ostream ostr = NULL);
+    wxLogStream(std::ostream *ostr = NULL);

 };
 
 
 };
 
 


@@ -405,8 +405,10 @@ public:
     @class wxLogStderr
 
     This class can be used to redirect the log messages to a C file stream (not to
     @class wxLogStderr
 
     This class can be used to redirect the log messages to a C file stream (not to

-    be confused with C++ streams). It is the default log target for the non-GUI
-    wxWidgets applications which send all the output to @c stderr.
+    be confused with C++ streams).
+
+    It is the default log target for the non-GUI wxWidgets applications which
+    send all the output to @c stderr.

 
     @library{wxbase}
     @category{logging}
 
     @library{wxbase}
     @category{logging}


@@ -443,6 +445,11 @@ public:
 class wxLogBuffer : public wxLog
 {
 public:
 class wxLogBuffer : public wxLog
 {
 public:

+    /**
+        The default ctor does nothing.
+    */
+    wxLogBuffer();
+

     /**
         Shows all the messages collected so far to the user (using a message box in the
         GUI applications or by printing them out to the console in text mode) and
     /**
         Shows all the messages collected so far to the user (using a message box in the
         GUI applications or by printing them out to the console in text mode) and


@@ -527,6 +534,9 @@ public:
     Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
     you may not even know about its existence.
 
     Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
     you may not even know about its existence.
 

+    @note For console-mode applications, the default target is wxLogStderr, so
+          that all @e wxLogXXX() functions print on @c stderr when @c wxUSE_GUI = 0.
+

 
     @section log_derivingyours Deriving your own log target
 
 
     @section log_derivingyours Deriving your own log target
 


@@ -627,7 +637,8 @@ public:
     @li SetRepetitionCounting()
     @li GetRepetitionCounting()
 
     @li SetRepetitionCounting()
     @li GetRepetitionCounting()
 

-    @note Timestamping is disabled for Visual C++ users in debug builds by
+    @note
+    Timestamping is disabled for Visual C++ users in debug builds by

     default because otherwise it would be impossible to directly go to the line
     from which the log message was generated by simply clicking in the debugger
     window on the corresponding error message. If you wish to enable it, please
     default because otherwise it would be impossible to directly go to the line
     from which the log message was generated by simply clicking in the debugger
     window on the corresponding error message. If you wish to enable it, please


@@ -1100,6 +1111,7 @@ void wxVLogTrace(const char* mask,
     function is that usually there are a lot of trace messages, so it might
     make sense to separate them from other debug messages.
 
     function is that usually there are a lot of trace messages, so it might
     make sense to separate them from other debug messages.
 

+    @deprecated

     This version of wxLogTrace() only logs the message if all the bits
     corresponding to the @a mask are set in the wxLog trace mask which can be
     set by calling wxLog::SetTraceMask(). This version is less flexible than
     This version of wxLogTrace() only logs the message if all the bits
     corresponding to the @a mask are set in the wxLog trace mask which can be
     set by calling wxLog::SetTraceMask(). This version is less flexible than