viff

changeset 1418:cbfa7ea6dae7

doc: added inheritance diagrams
author Martin Geisler <mg@cs.au.dk>
date Mon, 14 Dec 2009 13:01:24 +0100
parents abf0c99aff35
children f264239b594d
files doc/active.txt doc/comparison.txt doc/conf.py doc/field.txt doc/orlandi.txt doc/paillier.txt doc/passive.txt doc/runtime.txt
diffstat 8 files changed, 37 insertions(+), 1 deletions(-) [+]
line diff
     1.1 --- a/doc/active.txt	Mon Dec 14 12:12:28 2009 +0100
     1.2 +++ b/doc/active.txt	Mon Dec 14 13:01:24 2009 +0100
     1.3 @@ -7,9 +7,15 @@
     1.4     .. autoclass:: ActiveRuntime
     1.5        :members:
     1.6  
     1.7 +      .. inheritance-diagram:: ActiveRuntime
     1.8 +         :parts: 1
     1.9 +
    1.10     .. autoclass:: BasicActiveRuntime
    1.11        :members:
    1.12  
    1.13 +      .. inheritance-diagram:: BasicActiveRuntime
    1.14 +         :parts: 1
    1.15 +
    1.16     .. autoclass:: BrachaBroadcastMixin
    1.17        :members:
    1.18  
     2.1 --- a/doc/comparison.txt	Mon Dec 14 12:12:28 2009 +0100
     2.2 +++ b/doc/comparison.txt	Mon Dec 14 13:01:24 2009 +0100
     2.3 @@ -19,7 +19,13 @@
     2.4  
     2.5  .. autoclass:: viff.comparison.Toft05Runtime
     2.6  
     2.7 +   .. inheritance-diagram:: viff.comparison.Toft05Runtime
     2.8 +      :parts: 1
     2.9 +
    2.10  .. autoclass:: viff.comparison.ComparisonToft07Mixin
    2.11     :members: greater_than_equal
    2.12  
    2.13  .. autoclass:: viff.comparison.Toft07Runtime
    2.14 +
    2.15 +   .. inheritance-diagram:: viff.comparison.Toft07Runtime
    2.16 +      :parts: 1
     3.1 --- a/doc/conf.py	Mon Dec 14 12:12:28 2009 +0100
     3.2 +++ b/doc/conf.py	Mon Dec 14 13:01:24 2009 +0100
     3.3 @@ -31,7 +31,8 @@
     3.4  # Add any Sphinx extension module names here, as strings. They can be
     3.5  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
     3.6  # ones.
     3.7 -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig']
     3.8 +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig',
     3.9 +              'sphinx.ext.inheritance_diagram']
    3.10  
    3.11  # Add any paths that contain templates here, relative to this directory.
    3.12  templates_path = []
     4.1 --- a/doc/field.txt	Mon Dec 14 12:12:28 2009 +0100
     4.2 +++ b/doc/field.txt	Mon Dec 14 13:01:24 2009 +0100
     4.3 @@ -10,6 +10,9 @@
     4.4        :members: __add__, __mul__, __pow__, __div__, __neg__,
     4.5                  __invert__, __eq__, __nonzero__, __int__
     4.6  
     4.7 +      .. inheritance-diagram:: GF256
     4.8 +         :parts: 1
     4.9 +
    4.10        .. attribute:: GF256.modulus
    4.11  
    4.12           Field modulus, always 256.
     5.1 --- a/doc/orlandi.txt	Mon Dec 14 12:12:28 2009 +0100
     5.2 +++ b/doc/orlandi.txt	Mon Dec 14 13:01:24 2009 +0100
     5.3 @@ -10,6 +10,11 @@
     5.4     .. autoclass:: OrlandiShare
     5.5        :members:
     5.6  
     5.7 +      .. inheritance-diagram:: OrlandiShare
     5.8 +         :parts: 1
     5.9 +
    5.10     .. autoclass:: OrlandiRuntime
    5.11        :members:
    5.12  
    5.13 +      .. inheritance-diagram:: OrlandiRuntime
    5.14 +         :parts: 1
     6.1 --- a/doc/paillier.txt	Mon Dec 14 12:12:28 2009 +0100
     6.2 +++ b/doc/paillier.txt	Mon Dec 14 13:01:24 2009 +0100
     6.3 @@ -7,6 +7,9 @@
     6.4     .. autoclass:: PaillierRuntime
     6.5        :members:
     6.6  
     6.7 +      .. inheritance-diagram:: PaillierRuntime
     6.8 +         :parts: 1
     6.9 +
    6.10     .. autofunction:: encrypt
    6.11  
    6.12     .. autofunction:: decrypt
     7.1 --- a/doc/passive.txt	Mon Dec 14 12:12:28 2009 +0100
     7.2 +++ b/doc/passive.txt	Mon Dec 14 13:01:24 2009 +0100
     7.3 @@ -6,3 +6,6 @@
     7.4  
     7.5     .. autoclass:: PassiveRuntime
     7.6        :members:
     7.7 +
     7.8 +       .. inheritance-diagram:: PassiveRuntime
     7.9 +          :parts: 1
     8.1 --- a/doc/runtime.txt	Mon Dec 14 12:12:28 2009 +0100
     8.2 +++ b/doc/runtime.txt	Mon Dec 14 13:01:24 2009 +0100
     8.3 @@ -6,6 +6,9 @@
     8.4  
     8.5     .. autoclass:: Share
     8.6  
     8.7 +      .. inheritance-diagram:: Share
     8.8 +         :parts: 1
     8.9 +
    8.10        .. automethod:: Share.__init__
    8.11  
    8.12        .. automethod:: Share.clone
    8.13 @@ -23,11 +26,17 @@
    8.14  
    8.15     .. autoclass:: ShareList
    8.16  
    8.17 +      .. inheritance-diagram:: ShareList
    8.18 +         :parts: 1
    8.19 +
    8.20     .. autofunction gather_shares
    8.21  
    8.22     .. autoclass:: ShareExchanger
    8.23        :members: sendShare, sendData, loseConnection
    8.24  
    8.25 +      .. inheritance-diagram:: ShareExchanger
    8.26 +         :parts: 1
    8.27 +
    8.28        .. attribute:: ShareExchanger.incoming_data
    8.29  
    8.30           Data from our peer is put here, either as an empty