EasyLogger.html in eymiha_util-1.0.2

- old
+ new
@@ -1,218 +1,247 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Class: Eymiha::EasyLogger</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">Eymiha::EasyLogger</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/eymiha/util/easylog_rb.html">
-                lib/eymiha/util/easylog.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Logger
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-Primarily, <a href="EasyLogger.html">EasyLogger</a> provides a convienient
-interface to the Logger at the class level. The class contains a
-&quot;default&quot; instance of Logger to which the class methods send
-their log messages. By convention, the first instance created is made the
-default, however this can be changed. Of course, instances may be used
-directly for logging if desired. Instances format their log entries using
-an <a href="EasyLogFormatter.html">EasyLogFormatter</a>.
-</p>
-<p>
-Five class-level methods are built that have the same names as the instance
-methods: debug, info, warn, error and fatal. Their arguments are different,
-however, being the message to be logged and optionally, one or more Loggers
-to log the message. If no Loggers are passed, the default is used, and if
-that is nil,no logging takes place.
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000033">change_logger</a>&nbsp;&nbsp;
-      <a href="#M000034">finish_logging</a>&nbsp;&nbsp;
-      <a href="#M000032">new</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-    <div id="attribute-list">
-      <h3 class="section-bar">Attributes</h3>
-
-      <div class="name-list">
-        <table>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">classify</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        </table>
-      </div>
-    </div>
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000033" class="method-detail">
-        <a name="M000033"></a>
-
-        <div class="method-heading">
-          <a href="EasyLogger.src/M000033.html" target="Code" class="method-signature"
-            onclick="popupCode('EasyLogger.src/M000033.html');return false;">
-          <span class="method-name">change_logger</span><span class="method-args">(new)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Changes the default logger to the <a href="EasyLogger.html#M000032">new</a>
-logger.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000034" class="method-detail">
-        <a name="M000034"></a>
-
-        <div class="method-heading">
-          <a href="EasyLogger.src/M000034.html" target="Code" class="method-signature"
-            onclick="popupCode('EasyLogger.src/M000034.html');return false;">
-          <span class="method-name">finish_logging</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Sets the default logger to nil, indicating that further class level logging
-through the default logger mechanism is disabled.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000032" class="method-detail">
-        <a name="M000032"></a>
-
-        <div class="method-heading">
-          <a href="EasyLogger.src/M000032.html" target="Code" class="method-signature"
-            onclick="popupCode('EasyLogger.src/M000032.html');return false;">
-          <span class="method-name">new</span><span class="method-args">(logdev, shift_age = 'weekly', shift_size = 1048576, subsecond_precision = nil)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Creates a <a href="EasyLogger.html#M000032">new</a> <a
-href="EasyLogger.html">EasyLogger</a> instance. Logging is recorded through
-the given logdev, either an IO stream or to a file when logdev is a String
-containing its filename. Shift age is either the number of log files to
-keep, or the frequency of rotation. Shift size is the maximum logfile size,
-applicable when shift age is a number. Subsecond precision is the number of
-decimal places that express fractional seconds. If this is the first
-instance being created, it is remembered and used by the logging methods at
-the class level as the default logger.
-</p>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Eymiha::EasyLogger</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Eymiha::EasyLogger</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/eymiha/util/easylog_rb.html">
+                lib/eymiha/util/easylog.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Logger
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Primarily, <a href="EasyLogger.html">EasyLogger</a> provides a convienient
+interface to the Logger at the class <a
+href="EasyLogger.html#M000027">level</a>. The class contains a
+&quot;default&quot; instance of Logger to which the class methods send
+their log messages. By convention, the first instance created is made the
+default, however this can be changed. Of course, instances may be used
+directly for logging if desired. Instances format their log entries using
+an <a href="EasyLogFormatter.html">EasyLogFormatter</a>.
+</p>
+<p>
+Five class methods are built that have the same names as the instance
+methods: debug, info, warn, error and fatal. Their arguments are different,
+however, being the message to be logged and optionally, one or more Loggers
+to log the message. If no Loggers are passed, the default is used, and if
+that is nil,no logging takes place.
+</p>
+<p>
+Two other convenience class methods for each of the five Logger severities
+are also provided for checking and adjusting the threshold levels of the
+default logger. The debug?, info?, warn?, error? and fatal? methods return
+true if a message at that <a href="EasyLogger.html#M000027">level</a> will
+be reported by the default logger. Respectively, the level_debug,
+level_info, level_warn, level_error and level_fatal methods will set the
+threshold of the default logger to pass only messages at or above the
+selected severity.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000025">change_logger</a>&nbsp;&nbsp;
+      <a href="#M000026">finish_logging</a>&nbsp;&nbsp;
+      <a href="#M000027">level</a>&nbsp;&nbsp;
+      <a href="#M000024">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">classify</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000025.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000025.html');return false;">
+          <span class="method-name">change_logger</span><span class="method-args">(logger)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Changes the default logger to the given logger.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000026.html');return false;">
+          <span class="method-name">finish_logging</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Sets the default logger to nil, indicating that further logging by the
+class through the default logger mechanism is disabled.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000027.html');return false;">
+          <span class="method-name">level</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the threshold of the default logger if it exists, otherwise nil.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000024.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000024.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(logdev, shift_age = 'weekly', shift_size = 1048576,
 subsecond_precision = nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a <a href="EasyLogger.html#M000024">new</a> <a
+href="EasyLogger.html">EasyLogger</a> instance. Logging is recorded through
+the given logdev, either an IO stream or to a file when logdev is a String
+containing its filename. Shift age is either the number of log files to
+keep, or the frequency of rotation. Shift size is the maximum logfile size,
+applicable when shift age is a number. Subsecond precision is the number of
+decimal places that express fractional seconds. If this is the first
+instance being created, it is remembered and used by the logging methods at
+the class <a href="EasyLogger.html#M000027">level</a> as the default
+logger.
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
 </html>
\ No newline at end of file