viff

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 diff
     1.1 --- a/doc/runtime.txt	Mon Dec 14 11:10:40 2009 +0100
     1.2 +++ b/doc/runtime.txt	Mon Dec 14 11:21:21 2009 +0100
     1.3 @@ -5,7 +5,21 @@
     1.4  .. automodule:: viff.runtime
     1.5  
     1.6     .. autoclass:: Share
     1.7 -      :members: clone
     1.8 +
     1.9 +      .. automethod:: Share.__init__
    1.10 +
    1.11 +      .. automethod:: Share.clone
    1.12 +
    1.13 +      .. method:: __add__(other)
    1.14 +      .. method:: __sub__(other)
    1.15 +      .. method:: __mul__(other)
    1.16 +      .. method:: __xor__(other)
    1.17 +      .. method:: __lt__(other)
    1.18 +      .. method:: __eq__(other)
    1.19 +
    1.20 +         Overloaded operators. They all call back to the Runtime used
    1.21 +         when the Share was constructed. The reverse-argument versions
    1.22 +         are defined too.
    1.23  
    1.24     .. autoclass:: ShareList
    1.25