[doc] Add documentation for Backend::Api::BuildResults::Worker

src/api/lib/backend/api/build_results/worker.rb

@@ -1,11 +1,12 @@
-# API for accessing to the backend
 module Backend
   module Api
     module BuildResults
+      # Class that connect to endpoints related to the workers
       class Worker
         extend Backend::ConnectionHelper
 
         # Returns the worker status
+        # @return [String] XML with the status of the workers.
         def self.status
           get('/build/_workerstatus')
         end

src/api/lib/backend/doc/Backend/Api/BuildResults/Worker.html

@@ -104,7 +104,18 @@
 
 </div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+
+<p>Class that connect to endpoints related to the workers</p>
+
 
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
 
 
 
@@ -122,7 +133,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#status-class_method" title="status (class method)">.<strong>status</strong>  &#x21d2; Object </a>
+      <a href="#status-class_method" title="status (class method)">.<strong>status</strong>  &#x21d2; String </a>
 
 
 
@@ -161,7 +172,7 @@ <h2>Class Method Details</h2>
       <div class="method_details first">
   <h3 class="signature first" id="status-class_method">
 
-    .<strong>status</strong>  &#x21d2; <tt>Object</tt> 
+    .<strong>status</strong>  &#x21d2; <tt>String</tt> 
 
 
 
@@ -177,19 +188,37 @@ <h3 class="signature first" id="status-class_method">
 </div>
 <div class="tags">
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+    <li>
+
+
+        <span class='type'>(<tt>String</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'>
+<p>XML with the status of the workers.</p>
+</div>
+
+    </li>
+
+</ul>
 
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-9
 10
-11</pre>
+11
+12</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'api/build_results/worker.rb', line 9</span>
+      <pre class="code"><span class="info file"># File 'api/build_results/worker.rb', line 10</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span>
   <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/build/_workerstatus</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>