doc/AutoC.html in autoc-1.1 vs doc/AutoC.html in autoc-1.2
- old
+ new
@@ -4,11 +4,11 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: AutoC
- — Documentation by YARD 0.8.7.4
+ — Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
@@ -92,14 +92,14 @@
<p><strong>AutoC</strong> is a host of Ruby modules related to automatic C source code generation.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
-<p><span class='object_link'><a href="AutoC/Code.html" title="AutoC::Code (class)">Code</a></span> - generic C multi-source module generator.</p>
+<p><span class='object_link'><a href="AutoC/Code.html" title="AutoC::Code (class)">Code</a></span> generic C multi-source module generator.</p>
</li>
<li>
-<p><span class='object_link'><a href="AutoC/Collection.html" title="AutoC::Collection (class)">Collection</a></span> - strongly-typed data structure generators similar
+<p><span class='object_link'><a href="AutoC/Collection.html" title="AutoC::Collection (class)">Collection</a></span> strongly-typed data structure generators similar
to the C++ STL container classes.</p>
</li>
</ol>
</div>
<div class="sect1">
@@ -133,11 +133,11 @@
<strong class="modules">Modules:</strong> <span class='object_link'><a href="AutoC/Priority.html" title="AutoC::Priority (module)">Priority</a></span>
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="AutoC/Code.html" title="AutoC::Code (class)">Code</a></span>, <span class='object_link'><a href="AutoC/Collection.html" title="AutoC::Collection (class)">Collection</a></span>, <span class='object_link'><a href="AutoC/HashMap.html" title="AutoC::HashMap (class)">HashMap</a></span>, <span class='object_link'><a href="AutoC/HashSet.html" title="AutoC::HashSet (class)">HashSet</a></span>, <span class='object_link'><a href="AutoC/List.html" title="AutoC::List (class)">List</a></span>, <span class='object_link'><a href="AutoC/Module.html" title="AutoC::Module (class)">Module</a></span>, <span class='object_link'><a href="AutoC/Queue.html" title="AutoC::Queue (class)">Queue</a></span>, <span class='object_link'><a href="AutoC/Type.html" title="AutoC::Type (class)">Type</a></span>, <span class='object_link'><a href="AutoC/UserDefinedType.html" title="AutoC::UserDefinedType (class)">UserDefinedType</a></span>, <span class='object_link'><a href="AutoC/Vector.html" title="AutoC::Vector (class)">Vector</a></span>
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="AutoC/Code.html" title="AutoC::Code (class)">Code</a></span>, <span class='object_link'><a href="AutoC/Collection.html" title="AutoC::Collection (class)">Collection</a></span>, <span class='object_link'><a href="AutoC/HashMap.html" title="AutoC::HashMap (class)">HashMap</a></span>, <span class='object_link'><a href="AutoC/HashSet.html" title="AutoC::HashSet (class)">HashSet</a></span>, <span class='object_link'><a href="AutoC/List.html" title="AutoC::List (class)">List</a></span>, <span class='object_link'><a href="AutoC/Module.html" title="AutoC::Module (class)">Module</a></span>, <span class='object_link'><a href="AutoC/Queue.html" title="AutoC::Queue (class)">Queue</a></span>, <span class='object_link'><a href="AutoC/Reference.html" title="AutoC::Reference (class)">Reference</a></span>, <span class='object_link'><a href="AutoC/Type.html" title="AutoC::Type (class)">Type</a></span>, <span class='object_link'><a href="AutoC/UserDefinedType.html" title="AutoC::UserDefinedType (class)">UserDefinedType</a></span>, <span class='object_link'><a href="AutoC/Vector.html" title="AutoC::Vector (class)">Vector</a></span>
</p>
<h2>Constant Summary</h2>
@@ -145,11 +145,11 @@
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
</dt>
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.1</span><span class='tstring_end'>"</span></span></pre></dd>
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.2</span><span class='tstring_end'>"</span></span></pre></dd>
</dl>
@@ -167,10 +167,34 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
+ <a href="#c_id-class_method" title="c_id (class method)">+ (Object) <strong>c_id</strong>(obj) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><div class="paragraph">
+<p>Convert obj to string and return it.</p>
+</div></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
<a href="#priority_sort-class_method" title="priority_sort (class method)">+ (Object) <strong>priority_sort</strong>(entities, reverse = false) </a>
</span>
@@ -196,12 +220,58 @@
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
- <h3 class="signature first" id="priority_sort-class_method">
+ <h3 class="signature first" id="c_id-class_method">
+ + (<tt>Object</tt>) <strong>c_id</strong>(obj)
+
+
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+ <div class="paragraph">
+<p>Convert obj to string and return it.
+Throw NameError is resulting string is not a valid C identifier.</p>
+</div>
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+22
+23
+24
+25
+26</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/autoc/code.rb', line 22</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_c_id'>c_id</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+ <span class='comment'>#raise NameError.new("#{obj} is not a valid C identifier", obj) if (/^[_a-zA-Z]\w*$/ =~ obj).nil?
+</span> <span class='id identifier rubyid_obj'>obj</span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <h3 class="signature " id="priority_sort-class_method">
+
+ (<tt>Object</tt>) <strong>priority_sort</strong>(entities, reverse = false)
@@ -210,18 +280,18 @@
<tr>
<td>
<pre class="lines">
-123
-124
-125
-126
-127</pre>
+129
+130
+131
+132
+133</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/autoc/code.rb', line 123</span>
+ <pre class="code"><span class="info file"># File 'lib/autoc/code.rb', line 129</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_priority_sort'>priority_sort</span><span class='lparen'>(</span><span class='id identifier rubyid_entities'>entities</span><span class='comma'>,</span> <span class='id identifier rubyid_reverse'>reverse</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_list'>list</span> <span class='op'>=</span> <span class='id identifier rubyid_entities'>entities</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span><span class='period'>.</span><span class='id identifier rubyid_sort!'>sort!</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span><span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'><=></span> <span class='id identifier rubyid_b'>b</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_reverse!'>reverse!</span> <span class='kw'>unless</span> <span class='id identifier rubyid_reverse'>reverse</span>
<span class='id identifier rubyid_list'>list</span>
@@ -234,12 +304,12 @@
</div>
</div>
<div id="footer">
- Generated on Mon Jun 9 18:28:02 2014 by
+ Generated on Sat Nov 22 16:58:03 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.8.7.4 (ruby-2.0.0).
+ 0.8.7.6 (ruby-2.1.5).
</div>
</body>
</html>
\ No newline at end of file