propagate from branch 'net.randombit.botan' (head 294e2082ce9231d6165276e2f2a4153a0116aca3)

            to branch 'net.randombit.botan.c++0x' (head 0b695fad10f924601e07b009fcd781191fafcb28)

1 files changed, 29 insertions, 8 deletions

diff --git a/src/constructs/tss/tss.h b/src/constructs/tss/tss.h
index c8b0242d8..485e42c53 100644
--- a/src/constructs/tss/tss.h
+++ b/src/constructs/tss/tss.h
@@ -15,16 +15,19 @@
 
 namespace Botan {
 
+/**
+* A split secret, using the format from draft-mcgrew-tss-03
+*/
 class BOTAN_DLL RTSS_Share
    {
    public:
       /**
-      * @arg M the number of shares needed to reconstruct
-      * @arg N the number of shares generated
-      * @arg secret the secret to split
-      * @arg secret_len the length of the secret
-      * @arg identifier the 16 byte share identifier
-      * @arg rng the random number generator to use
+      * @param M the number of shares needed to reconstruct
+      * @param N the number of shares generated
+      * @param secret the secret to split
+      * @param secret_len the length of the secret
+      * @param identifier the 16 byte share identifier
+      * @param rng the random number generator to use
       */
       static std::vector<RTSS_Share>
          split(byte M, byte N,
@@ -33,18 +36,36 @@ class BOTAN_DLL RTSS_Share
                RandomNumberGenerator& rng);
 
       /**
-      * @arg shares the list of shares
+      * @param shares the list of shares
       */
       static SecureVector<byte>
         reconstruct(const std::vector<RTSS_Share>& shares);
 
       RTSS_Share() {}
-      RTSS_Share(const std::string&);
 
+      /**
+      * @param hex_input the share encoded in hexadecimal
+      */
+      RTSS_Share(const std::string& hex_input);
+
+      /**
+      * @return hex representation
+      */
       std::string to_string() const;
+
+      /**
+      * @return share identifier
+      */
       byte share_id() const;
 
+      /**
+      * @return size of this share in bytes
+      */
       u32bit size() const { return contents.size(); }
+
+      /**
+      * @return if this TSS share was initialized or not
+      */
       bool initialized() const { return (contents.size() > 0); }
    private:
       SecureVector<byte> contents;