You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by lu...@apache.org on 2010/07/09 01:49:29 UTC
svn commit: r962361 [1/8] - in /incubator/deltacloud/trunk/client/doc: ./
DeltaCloud/ DeltaCloud/Documentation/ DeltaCloud/HWP/
DeltaCloud/InstanceState/ DeltaCloud/PlainFormatter/
DeltaCloud/PlainFormatter/FormatObject/ css/ js/
Author: lutter
Date: Thu Jul 8 23:49:28 2010
New Revision: 962361
URL: http://svn.apache.org/viewvc?rev=962361&view=rev
Log:
Added generated docs for client
Added:
incubator/deltacloud/trunk/client/doc/
incubator/deltacloud/trunk/client/doc/DeltaCloud/
incubator/deltacloud/trunk/client/doc/DeltaCloud.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/API.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/Documentation/
incubator/deltacloud/trunk/client/doc/DeltaCloud/Documentation.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/Documentation/OperationParameter.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/HWP/
incubator/deltacloud/trunk/client/doc/DeltaCloud/HWP.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/HWP/FloatProperty.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/HWP/Property.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/HardwareProfile.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/Image.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/Instance.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/InstanceState/
incubator/deltacloud/trunk/client/doc/DeltaCloud/InstanceState.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/InstanceState/State.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/InstanceState/Transition.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/Base.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/HardwareProfile.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/Image.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/Instance.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/Realm.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/StorageSnapshot.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/PlainFormatter/FormatObject/StorageVolume.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/Realm.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/StorageSnapshot.html
incubator/deltacloud/trunk/client/doc/DeltaCloud/StorageVolume.html
incubator/deltacloud/trunk/client/doc/Kernel.html
incubator/deltacloud/trunk/client/doc/String.html
incubator/deltacloud/trunk/client/doc/_index.html
incubator/deltacloud/trunk/client/doc/class_list.html
incubator/deltacloud/trunk/client/doc/css/
incubator/deltacloud/trunk/client/doc/css/common.css
incubator/deltacloud/trunk/client/doc/css/full_list.css
incubator/deltacloud/trunk/client/doc/css/style.css
incubator/deltacloud/trunk/client/doc/file.README.html
incubator/deltacloud/trunk/client/doc/file_list.html
incubator/deltacloud/trunk/client/doc/frames.html
incubator/deltacloud/trunk/client/doc/index.html
incubator/deltacloud/trunk/client/doc/js/
incubator/deltacloud/trunk/client/doc/js/app.js
incubator/deltacloud/trunk/client/doc/js/full_list.js
incubator/deltacloud/trunk/client/doc/js/jquery.js
incubator/deltacloud/trunk/client/doc/method_list.html
incubator/deltacloud/trunk/client/doc/top-level-namespace.html
Added: incubator/deltacloud/trunk/client/doc/DeltaCloud.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/DeltaCloud.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/DeltaCloud.html (added)
+++ incubator/deltacloud/trunk/client/doc/DeltaCloud.html Thu Jul 8 23:49:28 2010
@@ -0,0 +1,305 @@
+<!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: DeltaCloud</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 (D)</a> »
+
+
+ <span class="title">DeltaCloud</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: DeltaCloud
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+ <dt class="r1 last">Defined in:</dt>
+ <dd class="r1 last">lib/deltacloud.rb<span class="defines">,<br />
+ doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> lib/plain_formatter.rb</span>
+</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+ <strong class="modules">Modules:</strong> <a href="DeltaCloud/HWP.html" title="DeltaCloud::HWP (module)">HWP</a>, <a href="DeltaCloud/InstanceState.html" title="DeltaCloud::InstanceState (module)">InstanceState</a>, <a href="DeltaCloud/PlainFormatter.html" title="DeltaCloud::PlainFormatter (module)">PlainFormatter</a>
+
+
+
+ <strong class="classes">Classes:</strong> <a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">API</a>, <a href="DeltaCloud/Documentation.html" title="DeltaCloud::Documentation (class)">Documentation</a>, <a href="DeltaCloud/HardwareProfile.html" title="DeltaCloud::HardwareProfile (class)">HardwareProfile</a>, <a href="DeltaCloud/Image.html" title="DeltaCloud::Image (class)">Image</a>, <a href="DeltaCloud/Instance.html" title="DeltaCloud::Instance (class)">Instance</a>, <a href="DeltaCloud/Realm.html" title="DeltaCloud::Realm (class)">Realm</a>, <a href="DeltaCloud/StorageSnapshot.html" title="DeltaCloud::StorageSnapshot (class)">StorageSnapshot</a>, <a href="DeltaCloud/StorageVolume.html" title="DeltaCloud::StorageVolume (class)">StorageVolume</a>
+
+
+</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="#driver_name-class_method" title="driver_name (class method)">+ (Object) <strong>driver_name</strong>(url) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>Return a API driver for specified URL.</p></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#new-class_method" title="new (class method)">+ (DeltaCloud::API) <strong>new</strong>(user_name, password, api_url, &block) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>Get a new API client instance.</p></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="driver_name-class_method">
+
+ + (<tt>Object</tt>) <strong>driver_name</strong>(url)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>Return a API driver for specified URL</p>
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Parameters:</h3>
+<ul class="param">
+
+ <li>
+
+ <span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>url</tt>)</span>
+
+
+ <span class='name'>API</span>
+
+
+
+ —
+ <div class='inline'><p>URL (eg. http://localhost:3001/api)</p></div>
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+38
+39
+40</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud.rb', line 38</span>
+
+<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='driver_name identifier id'>driver_name</span><span class='lparen token'>(</span><span class='url identifier id'>url</span><span class='rparen token'>)</span>
+ <span class='API constant id'>API</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='url identifier id'>url</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='driver_name identifier id'>driver_name</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="new-class_method">
+
+ + (<tt><a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">DeltaCloud::API</a></tt>) <strong>new</strong>(user_name, password, api_url, &block)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>Get a new API client instance</p>
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Parameters:</h3>
+<ul class="param">
+
+ <li>
+
+ <span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>user_name</tt>)</span>
+
+
+ <span class='name'>API</span>
+
+
+
+ —
+ <div class='inline'><p>user name</p></div>
+
+ </li>
+
+ <li>
+
+ <span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>password</tt>)</span>
+
+
+ <span class='name'>API</span>
+
+
+
+ —
+ <div class='inline'><p>password</p></div>
+
+ </li>
+
+ <li>
+
+ <span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>user_name</tt>)</span>
+
+
+ <span class='name'>API</span>
+
+
+
+ —
+ <div class='inline'><p>URL (eg. http://localhost:3001/api)</p></div>
+
+ </li>
+
+</ul>
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+ <span class='type'>(<tt><a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">DeltaCloud::API</a></tt>)</span>
+
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+31
+32
+33</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud.rb', line 31</span>
+
+<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='user_name identifier id'>user_name</span><span class='comma token'>,</span> <span class='password identifier id'>password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+ <span class='API constant id'>API</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='user_name identifier id'>user_name</span><span class='comma token'>,</span> <span class='password identifier id'>password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Mon Jun 28 11:12:53 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+ 0.5.6 (ruby-1.8.7).
+</div>
+
+ </body>
+</html>
\ No newline at end of file