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 [8/8] - in /incubator/deltacloud/trunk/client/doc: ./ DeltaCloud/ DeltaCloud/Documentation/ DeltaCloud/HWP/ DeltaCloud/InstanceState/ DeltaCloud/PlainFormatter/ DeltaCloud/PlainFormatter/FormatObject/ css/ js/

Added: incubator/deltacloud/trunk/client/doc/top-level-namespace.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/top-level-namespace.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/top-level-namespace.html (added)
+++ incubator/deltacloud/trunk/client/doc/top-level-namespace.html Thu Jul  8 23:49:28 2010
@@ -0,0 +1,301 @@
+<!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>Top Level Namespace</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</a> &raquo; 
+    
+    
+    <span class="title">Top Level Namespace</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>Top Level Namespace
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+   
+    
+      <strong class="modules">Modules:</strong> <a href="DeltaCloud.html" title="DeltaCloud (module)">DeltaCloud</a>, <a href="Kernel.html" title="Kernel (module)">Kernel</a>
+    
+   
+    
+      <strong class="classes">Classes:</strong> <a href="String.html" title="String (class)">String</a>
+    
+  
+</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="#read_method_description-instance_method" title="#read_method_description (instance method)">- (Object) <strong>read_method_description</strong>(c, method) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#read_parameters-instance_method" title="#read_parameters (instance method)">- (Object) <strong>read_parameters</strong>(c, method) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#read_return_value-instance_method" title="#read_return_value (instance method)">- (Object) <strong>read_return_value</strong>(c, method) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="read_method_description-instance_method">
+  
+    - (<tt>Object</tt>) <strong>read_method_description</strong>(c, method) 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/documentation.rb', line 17</span>
+
+<span class='def def kw'>def</span> <span class='read_method_description identifier id'>read_method_description</span><span class='lparen token'>(</span><span class='c identifier id'>c</span><span class='comma token'>,</span> <span class='method identifier id'>method</span><span class='rparen token'>)</span>
+  <span class='if if kw'>if</span> <span class='method identifier id'>method</span> <span class='match op'>=~</span> <span class='regexp val'>/es$/</span>
+    <span class='dstring node'>&quot;    # Read #{c.downcase} collection from Deltacloud API&quot;</span>
+  <span class='else else kw'>else</span>
+    <span class='case case kw'>case</span> <span class='method identifier id'>method</span>
+      <span class='when when kw'>when</span> <span class='string val'>&quot;uri&quot;</span>
+        <span class='string val'>&quot;    # Return URI to API for this object&quot;</span>
+      <span class='when when kw'>when</span> <span class='string val'>&quot;action_urls&quot;</span>
+        <span class='string val'>&quot;    # Return available actions API URL&quot;</span>
+      <span class='when when kw'>when</span> <span class='string val'>&quot;client&quot;</span>
+        <span class='string val'>&quot;    # Return instance of API client&quot;</span>
+      <span class='else else kw'>else</span>
+        <span class='dstring node'>&quot;    # Get #{method} attribute value from #{c.downcase}&quot;</span>
+    <span class='end end kw'>end</span>
+  <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="read_parameters-instance_method">
+  
+    - (<tt>Object</tt>) <strong>read_parameters</strong>(c, method) 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+34
+35
+36
+37
+38
+39
+40</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/documentation.rb', line 34</span>
+
+<span class='def def kw'>def</span> <span class='read_parameters identifier id'>read_parameters</span><span class='lparen token'>(</span><span class='c identifier id'>c</span><span class='comma token'>,</span> <span class='method identifier id'>method</span><span class='rparen token'>)</span>
+  <span class='out identifier id'>out</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
+  <span class='if if kw'>if</span> <span class='method identifier id'>method</span> <span class='match op'>=~</span> <span class='regexp val'>/es$/</span>
+    <span class='out identifier id'>out</span> <span class='lshft op'>&lt;&lt;</span> <span class='string val'>&quot;    # @param [String, #id] Filter by ID&quot;</span>
+  <span class='end end kw'>end</span>
+  <span class='out identifier id'>out</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='string val'>&quot;\n&quot;</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="read_return_value-instance_method">
+  
+    - (<tt>Object</tt>) <strong>read_return_value</strong>(c, method) 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+42
+43
+44
+45
+46
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/documentation.rb', line 42</span>
+
+<span class='def def kw'>def</span> <span class='read_return_value identifier id'>read_return_value</span><span class='lparen token'>(</span><span class='c identifier id'>c</span><span class='comma token'>,</span> <span class='method identifier id'>method</span><span class='rparen token'>)</span>
+  <span class='if if kw'>if</span> <span class='method identifier id'>method</span> <span class='match op'>=~</span> <span class='regexp val'>/es$/</span>
+    <span class='rt identifier id'>rt</span> <span class='assign token'>=</span> <span class='string val'>&quot;Array&quot;</span>
+  <span class='else else kw'>else</span>
+    <span class='rt identifier id'>rt</span> <span class='assign token'>=</span> <span class='string val'>&quot;String&quot;</span>
+  <span class='end end kw'>end</span>
+  <span class='dstring node'>&quot;    # @return [String] Value of #{method}&quot;</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:58 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