changeset 1416:c539b4196ea5

doc: document Share members
author Martin Geisler <mg@cs.au.dk>
date Mon, 14 Dec 2009 11:21:21 +0100
parents 424bf9fe18d4
children abf0c99aff35
files doc/runtime.txt
diffstat 1 files changed, 15 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/runtime.txt	Mon Dec 14 11:10:40 2009 +0100
+++ b/doc/runtime.txt	Mon Dec 14 11:21:21 2009 +0100
@@ -5,7 +5,21 @@
 .. automodule:: viff.runtime
 
    .. autoclass:: Share
-      :members: clone
+
+      .. automethod:: Share.__init__
+
+      .. automethod:: Share.clone
+
+      .. method:: __add__(other)
+      .. method:: __sub__(other)
+      .. method:: __mul__(other)
+      .. method:: __xor__(other)
+      .. method:: __lt__(other)
+      .. method:: __eq__(other)
+
+         Overloaded operators. They all call back to the Runtime used
+         when the Share was constructed. The reverse-argument versions
+         are defined too.
 
    .. autoclass:: ShareList