Permalink
Browse files

Update PHP and Python docs.

  • Loading branch information...
1 parent 8ff9547 commit bb5521289f3a6092b92581e820f04ad0a98bc0e2 Rusty Klophaus committed Mar 10, 2010
Showing with 229 additions and 179 deletions.
  1. +1 −1 client_lib/php/docs/allitems-frame.html
  2. +1 −1 client_lib/php/docs/deprecated-list.html
  3. +24 −18 client_lib/php/docs/index-all.html
  4. +1 −1 client_lib/php/docs/index.html
  5. +1 −1 client_lib/php/docs/overview-frame.html
  6. +1 −1 client_lib/php/docs/overview-summary.html
  7. +1 −1 client_lib/php/docs/overview-tree.html
  8. +1 −1 client_lib/php/docs/riakbucket/package-frame.html
  9. +1 −1 client_lib/php/docs/riakbucket/package-functions.html
  10. +1 −1 client_lib/php/docs/riakbucket/package-globals.html
  11. +1 −1 client_lib/php/docs/riakbucket/package-summary.html
  12. +1 −1 client_lib/php/docs/riakbucket/package-tree.html
  13. +33 −21 client_lib/php/docs/riakbucket/riakbucket.html
  14. +1 −1 client_lib/php/docs/riakclient/package-frame.html
  15. +1 −1 client_lib/php/docs/riakclient/package-functions.html
  16. +1 −1 client_lib/php/docs/riakclient/package-globals.html
  17. +1 −1 client_lib/php/docs/riakclient/package-summary.html
  18. +1 −1 client_lib/php/docs/riakclient/package-tree.html
  19. +19 −19 client_lib/php/docs/riakclient/riakclient.html
  20. +1 −1 client_lib/php/docs/riaklink/package-frame.html
  21. +1 −1 client_lib/php/docs/riaklink/package-functions.html
  22. +1 −1 client_lib/php/docs/riaklink/package-globals.html
  23. +1 −1 client_lib/php/docs/riaklink/package-summary.html
  24. +1 −1 client_lib/php/docs/riaklink/package-tree.html
  25. +13 −13 client_lib/php/docs/riaklink/riaklink.html
  26. +1 −1 client_lib/php/docs/riaklinkphase/package-frame.html
  27. +1 −1 client_lib/php/docs/riaklinkphase/package-functions.html
  28. +1 −1 client_lib/php/docs/riaklinkphase/package-globals.html
  29. +1 −1 client_lib/php/docs/riaklinkphase/package-summary.html
  30. +1 −1 client_lib/php/docs/riaklinkphase/package-tree.html
  31. +4 −4 client_lib/php/docs/riaklinkphase/riaklinkphase.html
  32. +1 −1 client_lib/php/docs/riakmapreduce/package-frame.html
  33. +1 −1 client_lib/php/docs/riakmapreduce/package-functions.html
  34. +1 −1 client_lib/php/docs/riakmapreduce/package-globals.html
  35. +1 −1 client_lib/php/docs/riakmapreduce/package-summary.html
  36. +1 −1 client_lib/php/docs/riakmapreduce/package-tree.html
  37. +1 −1 client_lib/php/docs/riakmapreduce/riakmapreduce.html
  38. +1 −1 client_lib/php/docs/riakmapreducephase/package-frame.html
  39. +1 −1 client_lib/php/docs/riakmapreducephase/package-functions.html
  40. +1 −1 client_lib/php/docs/riakmapreducephase/package-globals.html
  41. +1 −1 client_lib/php/docs/riakmapreducephase/package-summary.html
  42. +1 −1 client_lib/php/docs/riakmapreducephase/package-tree.html
  43. +4 −4 client_lib/php/docs/riakmapreducephase/riakmapreducephase.html
  44. +1 −1 client_lib/php/docs/riakobject/package-frame.html
  45. +1 −1 client_lib/php/docs/riakobject/package-functions.html
  46. +1 −1 client_lib/php/docs/riakobject/package-globals.html
  47. +1 −1 client_lib/php/docs/riakobject/package-summary.html
  48. +1 −1 client_lib/php/docs/riakobject/package-tree.html
  49. +48 −24 client_lib/php/docs/riakobject/riakobject.html
  50. +1 −1 client_lib/php/docs/riakstringio/package-frame.html
  51. +1 −1 client_lib/php/docs/riakstringio/package-functions.html
  52. +1 −1 client_lib/php/docs/riakstringio/package-globals.html
  53. +1 −1 client_lib/php/docs/riakstringio/package-summary.html
  54. +1 −1 client_lib/php/docs/riakstringio/package-tree.html
  55. +5 −5 client_lib/php/docs/riakstringio/riakstringio.html
  56. +1 −1 client_lib/php/docs/riakutils/package-frame.html
  57. +1 −1 client_lib/php/docs/riakutils/package-functions.html
  58. +1 −1 client_lib/php/docs/riakutils/package-globals.html
  59. +1 −1 client_lib/php/docs/riakutils/package-summary.html
  60. +1 −1 client_lib/php/docs/riakutils/package-tree.html
  61. +8 −8 client_lib/php/docs/riakutils/riakutils.html
  62. +19 −11 client_lib/python/docs/riak.html
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -62,7 +62,7 @@ <h1 id="letterB">B</h1>
<dt><a href="riakclient/riakclient.html#bucket()">bucket()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the bucket by the specified name. </dd>
<dt><a href="riakutils/riakutils.html#buildRestPath()">buildRestPath()</a> - Method in class <a href="riakutils/riakutils.html">RiakUtils.RiakUtils</a></dt>
-<dd>Given a ClientObject, BucketObject, Key, LinkSpec, and Params,
+<dd>Given a RiakClient, RiakBucket, Key, LinkSpec, and Params,
construct and return a URL.</dd>
</dl>
<h1 id="letterC">C</h1>
@@ -94,8 +94,10 @@ <h1 id="letterG">G</h1>
<dd>Retrieve a binary/string object from Riak.</dd>
<dt><a href="riaklink/riaklink.html#getBucket()">getBucket()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Get the bucket name of this link.</dd>
+<dt><a href="riakobject/riakobject.html#getBucket()">getBucket()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
+<dd>Get the bucket of this object.</dd>
<dt><a href="riakclient/riakclient.html#getClientID()">getClientID()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Get the clientID for this ClientObject.</dd>
+<dd>Get the clientID for this RiakClient.</dd>
<dt><a href="riakobject/riakobject.html#getContentType()">getContentType()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Get the content type of this object. </dd>
<dt><a href="riakobject/riakobject.html#getData()">getData()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
@@ -105,21 +107,25 @@ <h1 id="letterG">G</h1>
the DW-value for the client.</dd>
<dt><a href="riakclient/riakclient.html#getDW()">getDW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Get the DW-value for this ClientOBject. </dd>
+<dt><a href="riakobject/riakobject.html#getKey()">getKey()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
+<dd>Get the key of this object.</dd>
<dt><a href="riaklink/riaklink.html#getKey()">getKey()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Get the key of this link.</dd>
<dt><a href="riakobject/riakobject.html#getLinks()">getLinks()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Return an array of RiakLink objects.</dd>
+<dt><a href="riakbucket/riakbucket.html#getName()">getName()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
+<dd>Get the bucket name.</dd>
<dt><a href="riakbucket/riakbucket.html#getNVal()">getNVal()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve the N-value for this bucket.</dd>
<dt><a href="riakbucket/riakbucket.html#getProperties()">getProperties()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve an associative array of all bucket properties.</dd>
<dt><a href="riakbucket/riakbucket.html#getProperty()">getProperty()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Retrieve a bucket property.</dd>
+<dt><a href="riakclient/riakclient.html#getR()">getR()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
+<dd>Get the R-value setting for this RiakClient. </dd>
<dt><a href="riakbucket/riakbucket.html#getR()">getR()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Get the R-value for this bucket, if it is set, otherwise return
the R-value for the client.</dd>
-<dt><a href="riakclient/riakclient.html#getR()">getR()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Get the R-value setting for this ClientObject. </dd>
<dt><a href="riakobject/riakobject.html#getSibling()">getSibling()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Retrieve a sibling by sibling number.</dd>
<dt><a href="riakobject/riakobject.html#getSiblingCount()">getSiblingCount()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
@@ -128,11 +134,11 @@ <h1 id="letterG">G</h1>
<dd>Retrieve an array of siblings.</dd>
<dt><a href="riaklink/riaklink.html#getTag()">getTag()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Get the tag of this link.</dd>
-<dt><a href="riakclient/riakclient.html#getW()">getW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Get the W-value setting for this ClientObject. </dd>
<dt><a href="riakbucket/riakbucket.html#getW()">getW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Get the W-value for this bucket, if it is set, otherwise return
the W-value for the client.</dd>
+<dt><a href="riakclient/riakclient.html#getW()">getW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
+<dd>Get the W-value setting for this RiakClient. </dd>
</dl>
<h1 id="letterH">H</h1>
<dl>
@@ -146,27 +152,27 @@ <h1 id="letterH">H</h1>
<h1 id="letterI">I</h1>
<dl>
<dt><a href="riakclient/riakclient.html#isAlive()">isAlive()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Check if the Riak server for this ClientObject is alive.</dd>
+<dd>Check if the Riak server for this RiakClient is alive.</dd>
<dt><a href="riaklink/riaklink.html#isEqual()">isEqual()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Return true if the links are equal.</dd>
</dl>
<h1 id="letterL">L</h1>
<dl>
+<dt><a href="riakclient/riakclient.html#link()">link()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
+<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#link()">link()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Add a link phase to the map/reduce operation.</dd>
<dt><a href="riakobject/riakobject.html#link()">link()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
-<dt><a href="riakclient/riakclient.html#link()">link()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Start assembling a Map/Reduce operation.</dd>
</dl>
<h1 id="letterM">M</h1>
<dl>
<dt><a href="riakobject/riakobject.html#map()">map()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
-<dt><a href="riakmapreduce/riakmapreduce.html#map()">map()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
-<dd>Add a map phase to the map/reduce operation.</dd>
<dt><a href="riakclient/riakclient.html#map()">map()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
+<dt><a href="riakmapreduce/riakmapreduce.html#map()">map()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
+<dd>Add a map phase to the map/reduce operation.</dd>
</dl>
<h1 id="letterN">N</h1>
<dl>
@@ -186,11 +192,11 @@ <h1 id="letterP">P</h1>
</dl>
<h1 id="letterR">R</h1>
<dl>
-<dt><a href="riakclient/riakclient.html#reduce()">reduce()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
+<dt><a href="riakobject/riakobject.html#reduce()">reduce()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakmapreduce/riakmapreduce.html#reduce()">reduce()</a> - Method in class <a href="riakmapreduce/riakmapreduce.html">RiakMapReduce.RiakMapReduce</a></dt>
<dd>Add a reduce phase to the map/reduce operation.</dd>
-<dt><a href="riakobject/riakobject.html#reduce()">reduce()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
+<dt><a href="riakclient/riakclient.html#reduce()">reduce()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
<dd>Start assembling a Map/Reduce operation.</dd>
<dt><a href="riakobject/riakobject.html#reload()">reload()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Reload the object from Riak. </dd>
@@ -233,15 +239,15 @@ <h1 id="letterS">S</h1>
<dt><a href="riaklink/riaklink.html#setBucket()">setBucket()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Set the bucket name of this link.</dd>
<dt><a href="riakclient/riakclient.html#setClientID()">setClientID()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Set the clientID for this ClientObject. </dd>
+<dd>Set the clientID for this RiakClient. </dd>
<dt><a href="riakobject/riakobject.html#setContentType()">setContentType()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Set the content type of this object.</dd>
<dt><a href="riakobject/riakobject.html#setData()">setData()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
<dd>Set the data stored in this object. </dd>
<dt><a href="riakbucket/riakbucket.html#setDW()">setDW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the DW-value for this bucket. </dd>
<dt><a href="riakclient/riakclient.html#setDW()">setDW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Set the DW-value for this ClientObject. </dd>
+<dd>Set the DW-value for this RiakClient. </dd>
<dt><a href="riaklink/riaklink.html#setKey()">setKey()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Set the key of this link.</dd>
<dt><a href="riakbucket/riakbucket.html#setNVal()">setNVal()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
@@ -254,11 +260,11 @@ <h1 id="letterS">S</h1>
<dt><a href="riakbucket/riakbucket.html#setR()">setR()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the R-value for this bucket. </dd>
<dt><a href="riakclient/riakclient.html#setR()">setR()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Set the R-value for this ClientObject. </dd>
+<dd>Set the R-value for this RiakClient. </dd>
<dt><a href="riaklink/riaklink.html#setTag()">setTag()</a> - Method in class <a href="riaklink/riaklink.html">RiakLink.RiakLink</a></dt>
<dd>Set the tag of this link.</dd>
<dt><a href="riakclient/riakclient.html#setW()">setW()</a> - Method in class <a href="riakclient/riakclient.html">RiakClient.RiakClient</a></dt>
-<dd>Set the W-value for this ClientObject. </dd>
+<dd>Set the W-value for this RiakClient. </dd>
<dt><a href="riakbucket/riakbucket.html#setW()">setW()</a> - Method in class <a href="riakbucket/riakbucket.html">RiakBucket.RiakBucket</a></dt>
<dd>Set the W-value for this bucket. </dd>
<dt><a href="riakobject/riakobject.html#status()">status()</a> - Method in class <a href="riakobject/riakobject.html">RiakObject.RiakObject</a></dt>
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
@@ -4,7 +4,7 @@
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
-<meta name="when" content="Fri, 05 Mar 2010 15:26:37 -0500">
+<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">
<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">
Oops, something went wrong.

0 comments on commit bb55212

Please sign in to comment.