Permalink
Browse files

Added some documentation to new configure function. Issue #1 resolved…

…. Diego, could you test it now again? Thanks!
  • Loading branch information...
1 parent 3f6f712 commit 125291d5de26fd46b0a8a5b3a41f791789f2ee71 @jcague jcague committed Jul 26, 2012
Showing with 9 additions and 3 deletions.
  1. +2 −1 docs/JSTACK.Glance.html
  2. +2 −1 docs/JSTACK.Nova.Volume.html
  3. +2 −1 docs/JSTACK.Nova.html
  4. +1 −0 src/JSTACK.Glance.js
  5. +1 −0 src/JSTACK.Nova.Volume.js
  6. +1 −0 src/JSTACK.Nova.js
View
@@ -55,7 +55,8 @@
It could take one of the following values:
* "adminURL"
* "internalURL"
-* "publicURL"</p> </td> <td class="code"> <div class="highlight"><pre>
+* "publicURL"
+You can use this function to change the default endpointURL, which is publicURL.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">configure</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">endpointType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;adminURL&quot;</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;internalURL&quot;</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;publicURL&quot;</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">params</span><span class="p">.</span><span class="nx">endpointType</span> <span class="o">=</span> <span class="nx">endpointType</span><span class="p">;</span>
@@ -55,7 +55,8 @@
It could take one of the following values:
* "adminURL"
* "internalURL"
-* "publicURL"</p> </td> <td class="code"> <div class="highlight"><pre>
+* "publicURL"
+You can use this function to change the default endpointURL, which is publicURL.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">configure</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">endpointType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;adminURL&quot;</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;internalURL&quot;</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;publicURL&quot;</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">params</span><span class="p">.</span><span class="nx">endpointType</span> <span class="o">=</span> <span class="nx">endpointType</span><span class="p">;</span>
View
@@ -88,7 +88,8 @@
It could take one of the following values:
* "adminURL"
* "internalURL"
-* "publicURL"</p> </td> <td class="code"> <div class="highlight"><pre>
+* "publicURL"
+You can use this function to change the default endpointURL, which is publicURL. </p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">configure</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">endpointType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;adminURL&quot;</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;internalURL&quot;</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">&quot;publicURL&quot;</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">params</span><span class="p">.</span><span class="nx">endpointType</span> <span class="o">=</span> <span class="nx">endpointType</span><span class="p">;</span>
View
@@ -60,6 +60,7 @@ JSTACK.Glance = (function (JS, undefined) {
// * "adminURL"
// * "internalURL"
// * "publicURL"
+ // You can use this function to change the default endpointURL, which is publicURL.
configure = function (endpointType) {
if (endpointType === "adminURL" || endpointType === "internalURL" || endpointType === "publicURL") {
params.endpointType = endpointType;
@@ -60,6 +60,7 @@ JSTACK.Nova.Volume = (function (JS, undefined) {
// * "adminURL"
// * "internalURL"
// * "publicURL"
+ // You can use this function to change the default endpointURL, which is publicURL.
configure = function (endpointType) {
if (endpointType === "adminURL" || endpointType === "internalURL" || endpointType === "publicURL") {
params.endpointType = endpointType;
View
@@ -93,6 +93,7 @@ JSTACK.Nova = (function (JS, undefined) {
// * "adminURL"
// * "internalURL"
// * "publicURL"
+ // You can use this function to change the default endpointURL, which is publicURL.
configure = function (endpointType) {
if (endpointType === "adminURL" || endpointType === "internalURL" || endpointType === "publicURL") {
params.endpointType = endpointType;

0 comments on commit 125291d

Please sign in to comment.