Merge pull request #667 from bastelfreak/docs

regenerate puppet-strings docs
voxpupuli · Nov 19, 2017 · be30507 · be30507
2 parents 652f38f + 63f088d
commit be30507
Show file tree

Hide file tree

Showing 47 changed files with 11,889 additions and 0 deletions.
diff --git a/docs/Puppet/Provider/Rabbitmqctl.html b/docs/Puppet/Provider/Rabbitmqctl.html
@@ -0,0 +1,301 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Puppet::Provider::Rabbitmqctl
+
+    &mdash; Documentation by YARD 0.9.10
+
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "Puppet::Provider::Rabbitmqctl";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="../../_index.html">Index (R)</a> &raquo;
+    <span class='title'>Puppet</span> &raquo; <span class='title'>Provider</span>
+     &raquo; 
+    <span class="title">Rabbitmqctl</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="puppet_class_list_link"
+        href="../../puppet_class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: Puppet::Provider::Rabbitmqctl
+
+
+
+</h1>
+<div class="box_info">
+
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Puppet::Provider</span>
+
+        <ul class="fullTree">
+          <li>Object</li>
+
+            <li class="next">Puppet::Provider</li>
+
+            <li class="next">Puppet::Provider::Rabbitmqctl</li>
+
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+
+    </dd>
+  </dl>
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/puppet/provider/rabbitmqctl.rb</dd>
+  </dl>
+
+</div>
+
+
+
+
+
+
+
+
+
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#rabbitmq_version-class_method" title="rabbitmq_version (class method)">.<strong>rabbitmq_version</strong>  &#x21d2; Object </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#run_with_retries-class_method" title="run_with_retries (class method)">.<strong>run_with_retries</strong>(count = 30, step = 6, timeout = 10)  &#x21d2; Object </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'><p>Retry the given code block &#39;count&#39; retries or until the command suceeeds.</p>
+</div></span>
+
+</li>
+
+
+    </ul>
+
+
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+
+      <div class="method_details first">
+  <h3 class="signature first" id="rabbitmq_version-class_method">
+
+    .<strong>rabbitmq_version</strong>  &#x21d2; <tt>Object</tt> 
+
+
+
+
+
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+5
+6
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/puppet/provider/rabbitmqctl.rb', line 5</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_rabbitmq_version'>rabbitmq_version</span>
+  <span class='id identifier rubyid_output'>output</span> <span class='op'>=</span> <span class='id identifier rubyid_rabbitmqctl'>rabbitmqctl</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-q</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>status</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='id identifier rubyid_output'>output</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>\{rabbit,&quot;RabbitMQ&quot;,&quot;([\d\.]+)&quot;\}</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_version'>version</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_version'>version</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="run_with_retries-class_method">
+
+    .<strong>run_with_retries</strong>(count = 30, step = 6, timeout = 10)  &#x21d2; <tt>Object</tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Retry the given code block &#39;count&#39; retries or until the
+command suceeeds. Use &#39;step&#39; delay between retries.
+Limit each query time by &#39;timeout&#39;.
+For example:
+  users = self.class.run_with_retries { rabbitmqctl &#39;list_users&#39; }</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+
+    <li>
+
+
+        <span class='type'>(<tt>Puppet::Error</tt>)</span>
+
+
+
+    </li>
+
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/puppet/provider/rabbitmqctl.rb', line 16</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run_with_retries'>run_with_retries</span><span class='lparen'>(</span><span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>30</span><span class='comma'>,</span> <span class='id identifier rubyid_step'>step</span> <span class='op'>=</span> <span class='int'>6</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='int'>10</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__n'>_n</span><span class='op'>|</span>
+    <span class='kw'>begin</span>
+      <span class='id identifier rubyid_output'>output</span> <span class='op'>=</span> <span class='const'>Timeout</span><span class='period'>.</span><span class='id identifier rubyid_timeout'>timeout</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span> <span class='kw'>do</span>
+        <span class='kw'>yield</span>
+      <span class='kw'>end</span>
+    <span class='kw'>rescue</span> <span class='const'>Puppet</span><span class='op'>::</span><span class='const'>ExecutionFailure</span><span class='comma'>,</span> <span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span>
+      <span class='const'>Puppet</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Command failed, retrying</span><span class='tstring_end'>&#39;</span></span>
+      <span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_step'>step</span>
+    <span class='kw'>else</span>
+      <span class='const'>Puppet</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Command succeeded</span><span class='tstring_end'>&#39;</span></span>
+      <span class='kw'>return</span> <span class='id identifier rubyid_output'>output</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>Puppet</span><span class='op'>::</span><span class='const'>Error</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Command is still failing after </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_count'>count</span> <span class='op'>*</span> <span class='id identifier rubyid_step'>step</span><span class='embexpr_end'>}</span><span class='tstring_content'> seconds expired!</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+  </div>
+
+</div>
+
+      <div id="footer">
+     Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
+</div>
+
+    </div>
+  </body>
+</html>