]> git.saurik.com Git - wxWidgets.git/commitdiff
Mention log components in wxLogTrace() documentation.
authorVadim Zeitlin <vadim@wxwidgets.org>
Fri, 9 Oct 2009 13:04:44 +0000 (13:04 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Fri, 9 Oct 2009 13:04:44 +0000 (13:04 +0000)
Using different log components for different logging statements provides a
better (because more general and efficient) way to do the same thing that
wxLogTrace() does, so mention them when describing wxLogTrace().

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62348 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/log.h

index 9a7973ecac7c339cd2a9ae5ca5a81cd47a360ec6..04f57638d4bf001f84287f93ee5ad6b1d6e03a9a 100644 (file)
@@ -633,6 +633,11 @@ public:
 
     @section log_tracemasks Using trace masks
 
+    Notice that the use of log trace masks is hardly necessary any longer in
+    current wxWidgets version as the same effect can be achieved by using
+    different log components for different log statements of any level. Please
+    see @ref overview_log_enable for more information about the log components.
+
     The functions below allow some limited customization of wxLog behaviour
     without writing a new log target class (which, aside from being a matter of
     several minutes, allows you to do anything you want).
@@ -1257,6 +1262,13 @@ void wxVLogError(const char* formatString, va_list argPtr);
 /** @addtogroup group_funcmacro_log */
 //@{
 /**
+    Log a message at wxLOG_Trace log level.
+
+    Notice that the use of trace masks is not recommended any more as setting
+    the log components (please see @ref overview_log_enable) provides a way to
+    do the same thing for log messages of any level, and not just the tracing
+    ones.
+
     Like wxLogDebug(), trace functions only do something in debug builds and
     expand to nothing in the release one. The reason for making it a separate
     function is that usually there are a lot of trace messages, so it might