Merge branch 'ia/ssl/crypto/PSK-SRP/doc' into maint

* ia/ssl/crypto/PSK-SRP/doc: ssl & crypto: Documentation enhancements
jzmq · Apr 8, 2013 · 36bb8d8 · 36bb8d8
2 parents b9ef8ba + c8ecc84
commit 36bb8d8
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 10 deletions.
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
@@ -1287,23 +1287,24 @@ Mpint() = <![CDATA[<<ByteLen:32/integer-big, Bytes:ByteLen/binary>>]]>
       <fsummary>Generates SRP public keys</fsummary>
       <type>
 	<v>Verifier = binary()</v>
-	<d>Parameter v from <seealso marker="http://srp.stanford.edu/design.html">SRP design</seealso>
+	<d>Parameter v from <url href="http://srp.stanford.edu/design.html">SRP design</url>
 	 </d>
 	 <v>Generator = binary() </v>
-	 <d>Parameter g from <seealso marker="http://srp.stanford.edu/design.html">SRP design</seealso>
+	 <d>Parameter g from <url href="http://srp.stanford.edu/design.html">SRP design</url>
 	 </d>
 	<v>Prime = binary() </v>
-	<d>Parameter N from <seealso marker="http://srp.stanford.edu/design.html">SRP design</seealso>
+	<d>Parameter N from <url href="http://srp.stanford.edu/design.html">SRP design</url>
 	 </d>
 	 <v>Version = '3' |  '6' |  '6a' </v>
 	<d>SRP version, TLS SRP cipher suites uses '6a'.</d>
 	 <v>PublicKey = binary()</v>
-	 <d> Parameter A or B from <seealso marker="http://srp.stanford.edu/design.html">SRP design</seealso></d> 
-	 <v>PrivateKey = binary() - generated if not supplied</v>
-	 <d>Parameter a or b from <seealso marker="http://srp.stanford.edu/design.html">SRP design</seealso></d> 
+	 <d> Parameter A or B from <url href="http://srp.stanford.edu/design.html">SRP design</url></d>
+	 <v>Private = PrivateKey = binary() - generated if not supplied</v>
+	 <d>Parameter a or b from <url href="http://srp.stanford.edu/design.html">SRP design</url></d>
       </type>
       <desc>
-	<p>Generates SRP public keys</p>
+	<p>Generates SRP public keys for the client side (first argument is Generator)
+	or for the server side (first argument is Verifier).</p>
       </desc>
     </func>
 
@@ -1351,7 +1352,8 @@ Mpint() = <![CDATA[<<ByteLen:32/integer-big, Bytes:ByteLen/binary>>]]>
       </type>
       <desc>
 	<p>
-	  Computes the SRP session key (shared secret). Also used
+	  Computes the SRP session key (shared secret) for the client side (first argument is DerivedKey)
+	  or for the server side (first argument is Verifier). Also used
 	  as premaster secret by TLS-SRP ciher suites.
 	</p>
       </desc>

diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
@@ -305,9 +305,9 @@ fun(OtpCert :: #'OTPCertificate'{}, Event :: {bad_cert, Reason :: atom()} |
       <item>
 	<p>The lookup fun should be defined as:</p>
 	<code>
-fun(psk, PSKIdentity, UserState :: term()) ->
+fun(psk, PSKIdentity ::string(), UserState :: term()) ->
 	{ok, SharedSecret :: binary()} | error;
-fun(srp, Username, UserState :: term()) ->
+fun(srp, Username :: string(), UserState :: term()) ->
 	{ok, {SRPParams :: srp_param_type(), Salt :: binary(), DerivedKey :: binary()}} | error.
 	</code>