nobody at rubyforge.org
2007-Feb-12 19:30 UTC
[Wxruby-development] [867] trunk/wxruby2/doc/textile/log.txtl: Fix methods section, organise instance and class methods
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type"
content="text/html; charset=utf-8" /><style
type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:'':'';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family:
verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;
font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding:
6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid;
padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family:
verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch
.binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[867] trunk/wxruby2/doc/textile/log.txtl: Fix methods section,
organise instance and class methods</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>867</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2007-02-12 14:30:47 -0500 (Mon, 12 Feb
2007)</dd>
</dl>
<h3>Log Message</h3>
<pre>Fix methods section, organise instance and class methods</pre>
<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2doctextilelogtxtl">trunk/wxruby2/doc/textile/log.txtl</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2doctextilelogtxtl"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/doc/textile/log.txtl (866 => 867)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/log.txtl        2007-02-12
19:22:55 UTC (rev 866)
+++
trunk/wxruby2/doc/textile/log.txtl        2007-02-12
19:30:47 UTC (rev 867)
</span><span class="lines">@@ -33,18 +33,6 @@
</span><span class="cx"> only useful when the application
is terminating and shouldn''t be used in other
</span><span class="cx"> situations because it may easily
lead to a loss of messages.
</span><span class="cx">
</span><del>-"on_log":#Log_onlog
-
-"get_active_target":#Log_getactivetarget
-
-"set_active_target":#Log_setactivetarget
-
-"dont_create_on_demand":#Log_dontcreateondemand
-
-"Suspend":logsuspend.html
-
-"Resume":logresume.html
-
</del><span class="cx"> h3(#loggingfunctions). Logging
functions
</span><span class="cx">
</span><span class="cx"> There are two functions which
must be implemented by any derived class to
</span><span class="lines">@@ -136,34 +124,92 @@
</span><span class="cx"> window on the corresponding error
message. If you wish to enable it, please use
</span><span class="cx">
"set_timestamp":#Log_settimestamp explicitly.
</span><span class="cx">
</span><del>-"add_trace_mask":#Log_addtracemask
</del><span class="cx">
</span><del>-"remove_trace_mask":#Log_removetracemask
</del><ins>+h2. Class Methods
</ins><span class="cx">
</span><del>-"clear_trace_masks":#Log_cleartracemasks
</del><ins>+* "on_log":#Log_onlog
+* "get_active_target":#Log_getactivetarget
+* "set_active_target":#Log_setactivetarget
+* "dont_create_on_demand":#Log_dontcreateondemand
+* "suspend":#Log_suspend
+* "resume":#Log_resume
</ins><span class="cx">
</span><del>-"get_trace_masks":#Log_gettracemasks
</del><ins>+h2. Instance Methods
</ins><span class="cx">
</span><del>-"is_allowed_trace_mask":#Log_isallowedtracemask
</del><ins>+* "add_trace_mask":#Log_addtracemask
+* "remove_trace_mask":#Log_removetracemask
+* "clear_trace_masks":#Log_cleartracemasks
+* "get_trace_masks":#Log_gettracemasks
+* "is_allowed_trace_mask":#Log_isallowedtracemask
+* "set_verbose":#Log_setverbose
+* "get_verbose":#Log_getverbose
+* "set_timestamp":#Log_settimestamp
+* "get_timestamp":#Log_gettimestamp
+* "set_trace_mask":#Log_settracemask
+* "get_trace_mask":#Log_gettracemask
</ins><span class="cx">
</span><del>-"set_verbose":#Log_setverbose
</del><ins>+h3(#Log_onlog). Log.on_log
</ins><span class="cx">
</span><del>-"get_verbose":#Log_getverbose
</del><ins>+ *on_log*(%(arg-type)LogLevel% level, %(arg-type)char%
message)
</ins><span class="cx">
</span><del>-"set_timestamp":#Log_settimestamp
</del><ins>+Forwards the message at specified level to the _DoLog()_
function of the
+active log target if there is any, does nothing otherwise.
</ins><span class="cx">
</span><del>-"get_timestamp":#Log_gettimestamp
</del><ins>+h3(#Log_getactivetarget). Log.get_active_target
</ins><span class="cx">
</span><del>-"set_trace_mask":#Log_settracemask
</del><ins>+ "Log":log.html *get_active_target*()
</ins><span class="cx">
</span><del>-"get_trace_mask":#Log_gettracemask
</del><ins>+Returns the active log target (may be @nil@).
</ins><span class="cx">
</span><del>-2
</del><ins>+h3(#Log_setactivetarget). Log.set_active_target
</ins><span class="cx">
</span><del>-h4. Members
</del><ins>+ "Log":log.html
*set_active_target*(%(arg-type)Log% logtarget)
</ins><span class="cx">
</span><ins>+Sets the specified log target as the active one.
Returns the
+previous active log target (may be @nil@). To supress logging use a new
+instance of LogNull not @nil@. If the active log target is set to @nil@ a
+new default log target will be created when logging occurs.
</ins><span class="cx">
</span><ins>+h3(#Log_suspend). Log.suspend
</ins><span class="cx">
</span><ins>+ *suspend*()
+
+Suspends the logging until "Resume":logresume.html is called. Note
that
+the latter must be called the same number of times as the former to undo it,
+i.e. if you call Suspend() twice you must call Resume() twice as well.
+
+Note that suspending the logging means that the log sink won''t be be
flushed
+periodically, it doesn''t have any effect if the current log target
does the
+logging immediately without waiting for "Flush":logflush.html to be
+called (the standard GUI log target only shows the log dialog when it is
+flushed, so Suspend() works as expected with it).
+
+h4. See also
+
+"resume":logresume.html,
+
+"LogNull":logoverview.html
+
+h3(#Log_resume). Log.resume
+
+ *resume*()
+
+Resumes logging previously suspended by a call to
+"suspend":logsuspend.html. All messages logged in the meanwhile will
be
+flushed soon.
+
+h3(#Log_dontcreateondemand). Log.dont_create_on_demand
+
+ *dont_create_on_demand*()
+
+Instructs Log to not create new log targets on the fly if there is none
+currently. (Almost) for internal use only: it is supposed to be called by the
+application shutdown code.
+
+Note that this function also calls
+"clear_trace_masks":#Log_cleartracemasks.
+
+
</ins><span class="cx"> h3(#Log_addtracemask).
Log#add_trace_mask
</span><span class="cx">
</span><span class="cx">
*add_trace_mask*(%(arg-type)String% mask)
</span><span class="lines">@@ -197,56 +243,6 @@
</span><span class="cx">
</span><span class="cx">
"add_trace_mask":#Log_addtracemask.
</span><span class="cx">
</span><del>-h3(#Log_onlog). Log#on_log
-
- *on_log*(%(arg-type)LogLevel% level, %(arg-type)char% message)
-
-Forwards the message at specified level to the _DoLog()_ function of the
-active log target if there is any, does nothing otherwise.
-
-h3(#Log_getactivetarget). Log#get_active_target
-
- "Log":log.html *get_active_target*()
-
-Returns the pointer to the active log target (may be NULL).
-
-h3(#Log_setactivetarget). Log#set_active_target
-
- "Log":log.html *set_active_target*(%(arg-type)Log% logtarget)
-
-Sets the specified log target as the active one. Returns the pointer to the
-previous active log target (may be NULL). To supress logging use a new
-instance of LogNull not NULL. If the active log target is set to NULL a
-new default log target will be created when logging occurs.
-
-h3(#Log_suspend). Log#suspend
-
- *suspend*()
-
-Suspends the logging until "Resume":logresume.html is called. Note
that
-the latter must be called the same number of times as the former to undo it,
-i.e. if you call Suspend() twice you must call Resume() twice as well.
-
-Note that suspending the logging means that the log sink won''t be be
flushed
-periodically, it doesn''t have any effect if the current log target
does the
-logging immediately without waiting for "Flush":logflush.html to be
-called (the standard GUI log target only shows the log dialog when it is
-flushed, so Suspend() works as expected with it).
-
-h4. See also
-
-"Resume":logresume.html,
-
-"LogNull":logoverview.html
-
-h3(#Log_resume). Log#resume
-
- *resume*()
-
-Resumes logging previously suspended by a call to
-"Suspend":logsuspend.html. All messages logged in the meanwhile will
be
-flushed soon.
-
</del><span class="cx"> h3(#Log_dolog). Log#do_log
</span><span class="cx">
</span><span class="cx"> *do_log*(%(arg-type)LogLevel%
level, %(arg-type)Char% msg, %(arg-type)time_t% timestamp)
</span><span class="lines">@@ -269,17 +265,6 @@
</span><span class="cx"> A simple implementation may just
send the string to @stdout@ or, better,
</span><span class="cx"> @stderr@.
</span><span class="cx">
</span><del>-h3(#Log_dontcreateondemand). Log#dont_create_on_demand
-
- *dont_create_on_demand*()
-
-Instructs Log to not create new log targets on the fly if there is none
-currently. (Almost) for internal use only: it is supposed to be called by the
-application shutdown code.
-
-Note that this function also calls
-"clear_trace_masks":#Log_cleartracemasks.
-
</del><span class="cx"> h3(#Log_flush). Log#flush
</span><span class="cx">
</span><span class="cx"> *flush*()
</span></span></pre>
</div>
</div>
</body>
</html>
Reasonably Related Threads
Wisdom of the Ancients
