From 2c0b7c2a77ad5da376e85d208e29bd471061ac9a Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin
Date: Mon, 10 Jan 2011 16:29:16 +0100
Subject: Fixed Dialyzer specs
-------------------------------------------------------------------------
ssl's published documentation states:
ssl_accept(ListenSocket) ->
ssl_accept(ListenSocket, Timeout) -> ok | {error, Reason}
(see http://www.erlang.org/doc/man/ssl.html#ssl_accept-1)
while its code has the specs:
-spec ssl_accept(#sslsocket{}) -> {ok, #sslsocket{}} | {error, reason()}.
-spec ssl_accept(#sslsocket{}, list() | timeout()) -> {ok, #sslsocket{}} | {error, reason()}.
One of the two cannot be right. This should be fixed.
Moreover, I do not see why the spec just mentions list() for the options when the documentation explicitly mentions the options of ssl.
Kostis
---------------------------------------------------------------------
---
lib/ssl/doc/src/ssl.xml | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
(limited to 'lib/ssl/doc/src')
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index ec272379bb..daf7b77527 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -4,7 +4,7 @@
- 19992010
+ 19992011
Ericsson AB. All Rights Reserved.
@@ -72,10 +72,10 @@
{verify_fun, {fun(), term()}} |
{fail_if_no_peer_cert, boolean()}
{depth, integer()} |
- {cert, der_bin()}| {certfile, path()} |
- {key, der_bin()} | {keyfile, path()} | {password, string()} |
- {cacerts, [der_bin()]} | {cacertfile, path()} |
- |{dh, der_bin()} | {dhfile, path()} | {ciphers, ciphers()} |
+ {cert, der_encoded()}| {certfile, path()} |
+ {key, der_encoded()} | {keyfile, path()} | {password, string()} |
+ {cacerts, [der_encoded()]} | {cacertfile, path()} |
+ |{dh, der_encoded()} | {dhfile, path()} | {ciphers, ciphers()} |
{ssl_imp, ssl_imp()} | {reuse_sessions, boolean()} | {reuse_session, fun()}
@@ -95,7 +95,7 @@
path() = string() - representing a file path.
- der_bin() = binary() -Asn1 DER encoded entity as an erlang binary.
+ der_encoded() = binary() -Asn1 DER encoded entity as an erlang binary.
host() = hostname() | ipaddress()
@@ -136,14 +136,14 @@
- {cert, der_bin()}
+ {cert, der_encoded()}
- The DER encoded users certificate. If this option
is supplied it will override the certfile option.
{certfile, path()}
- Path to a file containing the user's certificate.
- {key, der_bin()}
+ {key, der_encoded()}
- The DER encoded users private key. If this option
is supplied it will override the keyfile option.
@@ -158,7 +158,7 @@
Only used if the private keyfile is password protected.
- {cacerts, [der_bin()]}
+ {cacerts, [der_encoded()]}
- The DER encoded trusted certificates. If this option
is supplied it will override the cacertfile option.
@@ -301,7 +301,7 @@ fun(OtpCert :: #'OTPCertificate'{}, Event :: {bad_cert, Reason :: atom()} |
- {dh, der_bin()}
+ {dh, der_encoded()}
- The DER encoded Diffie Hellman parameters. If this option
is supplied it will override the dhfile option.
--
cgit v1.2.3