Update documentation

1 files changed, 7 insertions, 1 deletions

diff --git a/fhmqv.h b/fhmqv.h
index 7d2fc1ca..eadacc80 100644
--- a/fhmqv.h
+++ b/fhmqv.h
@@ -31,7 +31,7 @@ public:
   virtual ~FHMQV_Domain() {}

 

   /// \brief Construct a FHMQV domain

-  /// \params clientRole flag indicating initiator or recipient

+  /// \param clientRole flag indicating initiator or recipient

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.

   FHMQV_Domain(bool clientRole = true)

@@ -39,6 +39,7 @@ public:
 

   /// \brief Construct a FHMQV domain

   /// \param params group parameters and options

+  /// \param clientRole flag indicating initiator or recipient

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.

   FHMQV_Domain(const GroupParameters &params, bool clientRole = true)

@@ -46,6 +47,7 @@ public:
 

   /// \brief Construct a FHMQV domain

   /// \param bt BufferedTransformation with group parameters and options

+  /// \param clientRole flag indicating initiator or recipient

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.

   FHMQV_Domain(BufferedTransformation &bt, bool clientRole = true)

@@ -57,6 +59,7 @@ public:
   /// \tparam T2 template parameter used as a constructor parameter

   /// \param v1 first parameter

   /// \param v2 second parameter

+  /// \param clientRole flag indicating initiator or recipient

   /// \details v1 and v2 are passed directly to the GROUP_PARAMETERS object.

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.

@@ -70,6 +73,7 @@ public:
   /// \tparam T2 template parameter used as a constructor parameter

   /// \param v1 first parameter

   /// \param v2 second parameter

+  /// \param clientRole flag indicating initiator or recipient

   /// \details v1 and v2 are passed directly to the GROUP_PARAMETERS object.

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.

@@ -85,6 +89,7 @@ public:
   /// \param v1 first parameter

   /// \param v2 second parameter

   /// \param v3 third parameter

+  /// \param clientRole flag indicating initiator or recipient

   /// \details v1, v2 and v3 are passed directly to the GROUP_PARAMETERS object.

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.

@@ -102,6 +107,7 @@ public:
   /// \param v2 second parameter

   /// \param v3 third parameter

   /// \param v4 third parameter

+  /// \param clientRole flag indicating initiator or recipient

   /// \details v1, v2, v3 and v4 are passed directly to the GROUP_PARAMETERS object.

   /// \details <tt>clientRole = true</tt> indicates initiator, and

   ///  <tt>clientRole = false</tt> indicates recipient or server.