Skip to content

Commit

Permalink
First import of YARD docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Bleigh committed Oct 14, 2010
0 parents commit 8323032
Show file tree
Hide file tree
Showing 50 changed files with 17,370 additions and 0 deletions.
233 changes: 233 additions & 0 deletions OmniAuth.html
@@ -0,0 +1,233 @@
<!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 name="Content-Type" content="text/html; charset=utf-8" />
<title>Module: OmniAuth</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') 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>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>

<div id="header">
<div id="menu">

<a href="_index.html">Index (O)</a> &raquo;


<span class="title">OmniAuth</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 id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>

<div class="clear"></div>
</div>

<iframe id="search_frame"></iframe>

<div id="content"><h1>Module: OmniAuth



</h1>

<dl class="box">








<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">oa-core/lib/omniauth/test.rb<span class="defines">,<br />
oa-core/lib/omniauth/core.rb,<br /> oa-core/lib/omniauth/form.rb,<br /> oa-oauth/lib/omniauth/oauth.rb,<br /> oa-basic/lib/omniauth/basic.rb,<br /> oa-core/lib/omniauth/builder.rb,<br /> oa-openid/lib/omniauth/openid.rb,<br /> oa-core/lib/omniauth/strategy.rb,<br /> oa-enterprise/lib/omniauth/enterprise.rb,<br /> oa-oauth/lib/omniauth/strategies/oauth.rb,<br /> oa-oauth/lib/omniauth/strategies/github.rb,<br /> oa-oauth/lib/omniauth/strategies/oauth2.rb,<br /> oa-oauth/lib/omniauth/strategies/gowalla.rb,<br /> oa-core/lib/omniauth/strategies/password.rb,<br /> oa-oauth/lib/omniauth/strategies/twitter.rb,<br /> oa-oauth/lib/omniauth/strategies/identica.rb,<br /> oa-core/lib/omniauth/test/strategy_macros.rb,<br /> oa-openid/lib/omniauth/strategies/open_id.rb,<br /> oa-oauth/lib/omniauth/strategies/facebook.rb,<br /> oa-enterprise/lib/omniauth/strategies/cas.rb,<br /> oa-oauth/lib/omniauth/strategies/linked_in.rb,<br /> oa-enterprise/lib/omniauth/strategies/ldap.rb,<br /> oa-oauth/lib/omniauth/strategies/foursquare.rb,<br /> oa-basic/lib/omniauth/strategies/http_basic.rb,<br /> oa-core/lib/omniauth/test/strategy_test_case.rb,<br /> oa-openid/lib/omniauth/strategies/google_apps.rb,<br /> oa-enterprise/lib/omniauth/strategies/ldap/adaptor.rb,<br /> oa-oauth/lib/omniauth/strategies/thirty_seven_signals.rb,<br /> oa-enterprise/lib/omniauth/strategies/cas/configuration.rb,<br /> oa-enterprise/lib/omniauth/strategies/cas/service_ticket_validator.rb</span>
</dd>

</dl>
<div class="clear"></div>

<h2>Defined Under Namespace</h2>
<p class="children">


<strong class="modules">Modules:</strong> <span class='object_link'><a href="OmniAuth/Strategies.html" title="OmniAuth::Strategies (module)">Strategies</a></span>, <span class='object_link'><a href="OmniAuth/Strategy.html" title="OmniAuth::Strategy (module)">Strategy</a></span>, <span class='object_link'><a href="OmniAuth/Test.html" title="OmniAuth::Test (module)">Test</a></span>, <span class='object_link'><a href="OmniAuth/Utils.html" title="OmniAuth::Utils (module)">Utils</a></span>



<strong class="classes">Classes:</strong> <span class='object_link'><a href="OmniAuth/Builder.html" title="OmniAuth::Builder (class)">Builder</a></span>, <span class='object_link'><a href="OmniAuth/Configuration.html" title="OmniAuth::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="OmniAuth/Form.html" title="OmniAuth::Form (class)">Form</a></span>


</p>




<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="#config-class_method" title="config (class method)">+ (Object) <strong>config</strong> </a>



</span>








<span class="summary_desc"><div class='inline'></div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#configure-class_method" title="configure (class method)">+ (Object) <strong>configure</strong> {|config| ... }</a>



</span>








<span class="summary_desc"><div class='inline'></div></span>

</li>


</ul>




<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>


<div class="method_details first">
<p class="signature first" id="config-class_method">

+ (<tt>Object</tt>) <strong>config</strong>



</p><table class="source_code">
<tr>
<td>
<pre class="lines">


47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'oa-core/lib/omniauth/core.rb', line 47</span>

<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='config identifier id'>config</span>
<span class='Configuration constant id'>Configuration</span><span class='dot token'>.</span><span class='instance identifier id'>instance</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
<p class="signature " id="configure-class_method">

+ (<tt>Object</tt>) <strong>configure</strong> {|config| ... }



</p><div class="docstring">
<div class="discussion">


</div>
</div>
<div class="tags">
<h3>Yields:</h3>
<ul class="yield">

<li>

<span class='type'>(<tt><span class='object_link'><a href="#config-class_method" title="OmniAuth.config (method)">config</a></span></tt>)</span>




</li>

</ul>

</div><table class="source_code">
<tr>
<td>
<pre class="lines">


51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'oa-core/lib/omniauth/core.rb', line 51</span>

<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='configure identifier id'>configure</span>
<span class='yield yield kw'>yield</span> <span class='config identifier id'>config</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>

</div>

</div>

<div id="footer">
Generated on Thu Oct 14 09:55:26 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.1 (ruby-1.8.7).
</div>

</body>
</html>

0 comments on commit 8323032

Please sign in to comment.