doc/classes/Autobuild/Reporting.html in autobuild-0.5.1 vs doc/classes/Autobuild/Reporting.html in autobuild-0.6
- old
+ new
@@ -3,11 +3,11 @@
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: Autobuild::Reporting</title>
+ <title>Module: Autobuild::Reporting</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[
@@ -47,11 +47,11 @@
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
- <td><strong>Class</strong></td>
+ <td><strong>Module</strong></td>
<td class="class-name-in-header">Autobuild::Reporting</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
@@ -60,39 +60,45 @@
</a>
<br />
</td>
</tr>
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
+ <div id="description">
+ <pre>
+ The reporting module provides the framework
+</pre>
+<p>
+to run commands in autobuild and report errors to the user
+</p>
+<p>
+It does not use a logging framework like Log4r, but it should ;-)
+</p>
+ </div>
+
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000098"><<</a>
- <a href="#M000099">each_log</a>
- <a href="#M000097">error</a>
- <a href="#M000095">report</a>
- <a href="#M000096">success</a>
+ <a href="#M000028"><<</a>
+ <a href="#M000029">each_log</a>
+ <a href="#M000027">error</a>
+ <a href="#M000025">report</a>
+ <a href="#M000026">success</a>
</div>
</div>
</div>
@@ -110,76 +116,97 @@
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
- <div id="method-M000098" class="method-detail">
- <a name="M000098"></a>
+ <div id="method-M000028" class="method-detail">
+ <a name="M000028"></a>
<div class="method-heading">
- <a href="Reporting.src/M000098.html" target="Code" class="method-signature"
- onclick="popupCode('Reporting.src/M000098.html');return false;">
+ <a href="Reporting.src/M000028.html" target="Code" class="method-signature"
+ onclick="popupCode('Reporting.src/M000028.html');return false;">
<span class="method-name"><<</span><span class="method-args">(reporter)</span>
</a>
</div>
<div class="method-description">
+ <p>
+Add a new reporter
+</p>
</div>
</div>
- <div id="method-M000099" class="method-detail">
- <a name="M000099"></a>
+ <div id="method-M000029" class="method-detail">
+ <a name="M000029"></a>
<div class="method-heading">
- <a href="Reporting.src/M000099.html" target="Code" class="method-signature"
- onclick="popupCode('Reporting.src/M000099.html');return false;">
+ <a href="Reporting.src/M000029.html" target="Code" class="method-signature"
+ onclick="popupCode('Reporting.src/M000029.html');return false;">
<span class="method-name">each_log</span><span class="method-args">(&iter)</span>
</a>
</div>
<div class="method-description">
+ <p>
+Iterate on all log files
+</p>
</div>
</div>
- <div id="method-M000097" class="method-detail">
- <a name="M000097"></a>
+ <div id="method-M000027" class="method-detail">
+ <a name="M000027"></a>
<div class="method-heading">
- <a href="Reporting.src/M000097.html" target="Code" class="method-signature"
- onclick="popupCode('Reporting.src/M000097.html');return false;">
+ <a href="Reporting.src/M000027.html" target="Code" class="method-signature"
+ onclick="popupCode('Reporting.src/M000027.html');return false;">
<span class="method-name">error</span><span class="method-args">(error)</span>
</a>
</div>
<div class="method-description">
+ <p>
+Reports that the build failed to the user
+</p>
</div>
</div>
- <div id="method-M000095" class="method-detail">
- <a name="M000095"></a>
+ <div id="method-M000025" class="method-detail">
+ <a name="M000025"></a>
<div class="method-heading">
- <a href="Reporting.src/M000095.html" target="Code" class="method-signature"
- onclick="popupCode('Reporting.src/M000095.html');return false;">
+ <a href="Reporting.src/M000025.html" target="Code" class="method-signature"
+ onclick="popupCode('Reporting.src/M000025.html');return false;">
<span class="method-name">report</span><span class="method-args">() {|| ...}</span>
</a>
</div>
<div class="method-description">
+ <pre>
+ Run a block and report known exception
+</pre>
+<p>
+If an exception is fatal, the program is terminated using exit()
+</p>
+<p>
+:yield:
+</p>
</div>
</div>
- <div id="method-M000096" class="method-detail">
- <a name="M000096"></a>
+ <div id="method-M000026" class="method-detail">
+ <a name="M000026"></a>
<div class="method-heading">
- <a href="Reporting.src/M000096.html" target="Code" class="method-signature"
- onclick="popupCode('Reporting.src/M000096.html');return false;">
+ <a href="Reporting.src/M000026.html" target="Code" class="method-signature"
+ onclick="popupCode('Reporting.src/M000026.html');return false;">
<span class="method-name">success</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
+ <p>
+Reports a successful build to the user
+</p>
</div>
</div>
</div>
\ No newline at end of file