<!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> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: Como::ComoCommon — Documentation by YARD 0.8.6.1 </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"> hasFrames = window.top.frames.main ? true : false; relpath = '../'; framesUrl = "../frames.html#!" + escape(window.location.href); </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 id="header"> <div id="menu"> <a href="../_index.html">Index (C)</a> » <span class='title'><span class='object_link'><a href="../Como.html" title="Como (module)">Como</a></span></span> » <span class="title">ComoCommon</span> <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../class_list.html"> Class List </a> <a class="full_list_link" id="method_list_link" href="../method_list.html"> Method List </a> <a class="full_list_link" id="file_list_link" href="../file_list.html"> File List </a> </div> <div class="clear"></div> </div> <iframe id="search_frame"></iframe> <div id="content"><h1>Class: Como::ComoCommon </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">Como::ComoCommon</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/como.rb<span class="defines">,<br /> lib/version.rb</span> </dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>IO stream options for Como classes.</p> </div> </div> <div class="tags"> </div><div id="subclasses"> <h2>Direct Known Subclasses</h2> <p class="children"><span class='object_link'><a href="Opt.html" title="Como::Opt (class)">Opt</a></span>, <span class='object_link'><a href="RuleDisplay.html" title="Como::RuleDisplay (class)">RuleDisplay</a></span>, <span class='object_link'><a href="Spec.html" title="Como::Spec (class)">Spec</a></span></p> </div> <h2>Constant Summary</h2> <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'>0.1.3</span><span class='tstring_end'>"</span></span></pre></dd> <dt id="io-classvariable" class="">@@io = <div class="docstring"> <div class="discussion"> <p>Default value for display output.</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='const'>STDOUT</span></pre></dd> <dt id="hook-classvariable" class="">@@hook = <div class="docstring"> <div class="discussion"> <p>Hooks.</p> </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span></pre></dd> </dl> <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="#getIo-class_method" title="getIo (class method)">+ (Object) <strong>getIo</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Get @@io.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#runHook-class_method" title="runHook (class method)">+ (Object) <strong>runHook</strong>(name, args) </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#setHook-class_method" title="setHook (class method)">+ (Object) <strong>setHook</strong>(name, &code) </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#setIo-class_method" title="setIo (class method)">+ (Object) <strong>setIo</strong>(io) </a> </span> <span class="summary_desc"><div class='inline'> <p>Set @@io.</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="getIo-class_method"> + (<tt>Object</tt>) <strong>getIo</strong> </h3><div class="docstring"> <div class="discussion"> <p>Get @@io.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 480 481 482</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/como.rb', line 480</span> <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_getIo'>getIo</span> <span class='cvar'>@@io</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="runHook-class_method"> + (<tt>Object</tt>) <strong>runHook</strong>(name, args) </h3><table class="source_code"> <tr> <td> <pre class="lines"> 488 489 490</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/como.rb', line 488</span> <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_runHook'>runHook</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span> <span class='cvar'>@@hook</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_yield'>yield</span><span class='lparen'>(</span> <span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='cvar'>@@hook</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="setHook-class_method"> + (<tt>Object</tt>) <strong>setHook</strong>(name, &code) </h3><table class="source_code"> <tr> <td> <pre class="lines"> 484 485 486</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/como.rb', line 484</span> <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_setHook'>setHook</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span> <span class='cvar'>@@hook</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="setIo-class_method"> + (<tt>Object</tt>) <strong>setIo</strong>(io) </h3><div class="docstring"> <div class="discussion"> <p>Set @@io.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 475 476 477</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/como.rb', line 475</span> <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_setIo'>setIo</span><span class='lparen'>(</span> <span class='id identifier rubyid_io'>io</span> <span class='rparen'>)</span> <span class='cvar'>@@io</span> <span class='op'>=</span> <span class='id identifier rubyid_io'>io</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Wed Jul 9 14:02:42 2014 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.6.1 (ruby-1.9.3). </div> </body> </html>