doc/Guard/PHPSpec.html
<!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: Guard::PHPSpec
— Documentation by YARD 0.8.7
</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 (P)</a> »
<span class='title'><span class='object_link'><a href="../Guard.html" title="Guard (module)">Guard</a></span></span>
»
<span class="title">PHPSpec</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: Guard::PHPSpec
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="../Guard.html" title="Guard (module)">Guard</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Guard.html" title="Guard (module)">Guard</a></span></li>
<li class="next">Guard::PHPSpec</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/guard/phpspec.rb<span class="defines">,<br />
lib/guard/phpspec/error.rb,<br /> lib/guard/phpspec/application.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="PHPSpec/ApplicationNotFoundError.html" title="Guard::PHPSpec::ApplicationNotFoundError (class)">ApplicationNotFoundError</a></span>, <span class='object_link'><a href="PHPSpec/ArgumentError.html" title="Guard::PHPSpec::ArgumentError (class)">ArgumentError</a></span>, <span class='object_link'><a href="PHPSpec/CommandNotFoundError.html" title="Guard::PHPSpec::CommandNotFoundError (class)">CommandNotFoundError</a></span>, <span class='object_link'><a href="PHPSpec/Error.html" title="Guard::PHPSpec::Error (class)">Error</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="DEFAULT_OPTIONS-constant" class="">DEFAULT_OPTIONS =
<div class="docstring">
<div class="discussion">
<p>autoload :Inspector, 'guard/phpspec/inspector' autoload :Formatter,
'guard/phpspec/formatter' autoload :Notifier,
'guard/phpspec/notifier' autoload :Runner,
'guard/phpspec/runner'</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='symbol'>:all_on_start</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:all_after_pass</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:keep_failed</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:cli</span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='symbol'>:tests_path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span><span class='embexpr_end'>}</span><span class='tstring_content'>/spec</span><span class='tstring_end'>"</span></span>
<span class='rbrace'>}</span></pre></dd>
</dl>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="../Guard.html" title="Guard (module)">Guard</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Guard.html#VERSION-constant" title="Guard::VERSION (constant)">VERSION</a></span></p>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (PHPSpec) <strong>initialize</strong> </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of PHPSpec.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Guard::PHPSpec (class)">PHPSpec</a></span></tt>) <strong>initialize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of PHPSpec</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>Exception</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/guard/phpspec.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Exception</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>guard-phpspec is work in progress. not ready for use at the moment</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Aug 26 02:46:10 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7 (ruby-2.0.0).
</div>
</body>
</html>