changeset 1238:199782817963

Added documentation for constants.py.
author Janus Dam Nielsen <janus.nielsen@alexandra.dk>
date Thu, 08 Oct 2009 11:51:56 +0200
parents 4b6f9e4db99e
children 61dfbce77505
files doc/constants.txt doc/implementation.txt doc/runtime.txt
diffstat 3 files changed, 25 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/constants.txt	Thu Oct 08 11:51:56 2009 +0200
@@ -0,0 +1,24 @@
+Constants Module
+================
+
+.. automodule:: viff.constants
+
+   .. attribute:: SHARE
+                  ECHO
+                  READY
+                  SEND
+                  PAILLIER
+                  TEXT
+
+      Constants used by :class:`ShareExchanger` and others when sending 
+      shares and other messages. They serve to distinguish messages sent 
+      with the same program counter from one another.
+
+   .. attribute::INCONSISTENTHASH
+                  OK
+                  HASH
+                  SIGNAL
+
+      Constants used by :class:`HashBroadcastMixin` when sending shares
+      and other messages. They serve to distinguish messages sent with
+      the same program counter from one another.
--- a/doc/implementation.txt	Wed Oct 07 12:03:06 2009 +0200
+++ b/doc/implementation.txt	Thu Oct 08 11:51:56 2009 +0200
@@ -19,3 +19,4 @@
    prss
    config
    aes
+   constants
--- a/doc/runtime.txt	Wed Oct 07 12:03:06 2009 +0200
+++ b/doc/runtime.txt	Thu Oct 08 11:51:56 2009 +0200
@@ -21,16 +21,6 @@
          or the data itself if data is received from the other player
          before we are ready to use it.
 
-   .. attribute:: SHARE
-                  ECHO
-                  READY
-                  SEND
-                  PAILLIER
-
-      Constants used by :class:`ShareExchanger` when sending shares
-      and other messages. They serve to distinguish messages sent with
-      the same program counter from one another.
-
    .. autofunction:: preprocess
 
       See also :ref:`preprocessing` for more background information.