From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 17:42:39 +0100 Subject: Add "since" attributes in xml for new functions and modules introduced after OTP_R13B03. --- lib/inets/doc/src/http_uri.xml | 12 ++++---- lib/inets/doc/src/httpc.xml | 50 +++++++++++++++++----------------- lib/inets/doc/src/httpd.xml | 2 +- lib/inets/doc/src/httpd_custom_api.xml | 8 +++--- lib/inets/doc/src/mod_auth.xml | 2 +- lib/inets/doc/src/mod_security.xml | 4 +-- 6 files changed, 39 insertions(+), 39 deletions(-) (limited to 'lib/inets/doc/src') diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml index 2dec5acbf9..6d3547f4fe 100644 --- a/lib/inets/doc/src/http_uri.xml +++ b/lib/inets/doc/src/http_uri.xml @@ -30,7 +30,7 @@ - http_uri + http_uri URI utility module @@ -79,7 +79,7 @@ - decode(HexEncodedURI) -> URI + decode(HexEncodedURI) -> URI Decodes a hexadecimal encoded URI. @@ -93,7 +93,7 @@ - encode(URI) -> HexEncodedURI + encode(URI) -> HexEncodedURI Encodes a hexadecimal encoded URI. @@ -109,8 +109,8 @@ - parse(URI) -> {ok, Result} | {error, Reason} - parse(URI, Options) -> {ok, Result} | {error, Reason} + parse(URI) -> {ok, Result} | {error, Reason} + parse(URI, Options) -> {ok, Result} | {error, Reason} Parses a URI. URI = uri() @@ -165,7 +165,7 @@ fun(SchemeStr :: string() | binary()) -> - scheme_defaults() -> SchemeDefaults + scheme_defaults() -> SchemeDefaults A list of the scheme and their default ports. SchemeDefaults = [{scheme(), default_scheme_port_number()}] diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml index a2871f3b95..7451b314ec 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -30,7 +30,7 @@ - httpc + httpc An HTTP/1.1 client @@ -151,8 +151,8 @@ - cancel_request(RequestId) -> - cancel_request(RequestId, Profile) -> ok + cancel_request(RequestId) -> + cancel_request(RequestId, Profile) -> ok Cancels an asynchronous HTTP request. RequestId = request_id() - A unique identifier as returned @@ -169,9 +169,9 @@ - cookie_header(Url) -> - cookie_header(Url, Profile | Opts) -> header() | {error, Reason} - cookie_header(Url, Opts, Profile) -> header() | {error, Reason} + cookie_header(Url) -> + cookie_header(Url, Profile | Opts) -> header() | {error, Reason} + cookie_header(Url, Opts, Profile) -> header() | {error, Reason} Returns the cookie header that would have been sent when making a request to URL using the profile Profile. @@ -193,8 +193,8 @@ - get_options(OptionItems) -> {ok, Values} | {error, Reason} - get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason} + get_options(OptionItems) -> {ok, Values} | {error, Reason} + get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason} Gets the currently used options. OptionItems = all | [option_item()] @@ -223,8 +223,8 @@ - info() -> list() - info(Profile) -> list() + info() -> list() + info(Profile) -> list() Produces a list of miscellaneous information. Profile = profile() | pid() @@ -239,8 +239,8 @@ - reset_cookies() -> void() - reset_cookies(Profile) -> void() + reset_cookies() -> void() + reset_cookies(Profile) -> void() Resets the cookie database. Profile = profile() | pid() @@ -254,8 +254,8 @@ - request(Url) -> - request(Url, Profile) -> {ok, Result} | {error, Reason} + request(Url) -> + request(Url, Profile) -> {ok, Result} | {error, Reason} Sends a get HTTP request. Url = url() @@ -272,8 +272,8 @@ - request(Method, Request, HTTPOptions, Options) -> - request(Method, Request, HTTPOptions, Options, Profile) -> {ok, Result} | {ok, saved_to_file} | {error, Reason} + request(Method, Request, HTTPOptions, Options) -> + request(Method, Request, HTTPOptions, Options, Profile) -> {ok, Result} | {ok, saved_to_file} | {error, Reason} Sends an HTTP request. @@ -521,8 +521,8 @@ - set_options(Options) -> - set_options(Options, Profile) -> ok | {error, Reason} + set_options(Options) -> + set_options(Options, Profile) -> ok | {error, Reason} Sets options to be used for subsequent requests. Options = [Option] @@ -639,8 +639,8 @@ - store_cookies(SetCookieHeaders, Url) -> - store_cookies(SetCookieHeaders, Url, Profile) -> ok | {error, Reason} + store_cookies(SetCookieHeaders, Url) -> + store_cookies(SetCookieHeaders, Url, Profile) -> ok | {error, Reason} Saves the cookies defined in SetCookieHeaders in the client profile cookie database. @@ -658,7 +658,7 @@ - stream_next(Pid) -> ok + stream_next(Pid) -> ok Triggers the next message to be streamed, that is, the same behavior as active one for sockets. @@ -676,8 +676,8 @@ - which_cookies() -> cookies() - which_cookies(Profile) -> cookies() + which_cookies() -> cookies() + which_cookies(Profile) -> cookies() Dumps the entire cookie database. Profile = profile() | pid() @@ -695,8 +695,8 @@ - which_sessions() -> session_info() - which_sessions(Profile) -> session_info() + which_sessions() -> session_info() + which_sessions(Profile) -> session_info() Produces a slightly processed dump of the sessions database. Profile = profile() | pid() diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 2c70c2b050..1a203fae90 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -901,7 +901,7 @@ text/plain asc txt info(Address, Port) -> info(Address, Port, Profile) -> - info(Address, Port, Profile, Properties) -> [{Option, Value}] + info(Address, Port, Profile, Properties) -> [{Option, Value}] info(Address, Port, Properties) -> [{Option, Value}] Fetches information about the HTTP server. diff --git a/lib/inets/doc/src/httpd_custom_api.xml b/lib/inets/doc/src/httpd_custom_api.xml index d2e5441895..2c0f92ff83 100644 --- a/lib/inets/doc/src/httpd_custom_api.xml +++ b/lib/inets/doc/src/httpd_custom_api.xml @@ -25,7 +25,7 @@ httpd_custom_api httpd_custom_api.xml - httpd_custom_api + httpd_custom_api Behaviour with optional callbacks to customize the inets HTTP server.

The module implementing this behaviour shall be supplied to to the servers @@ -34,7 +34,7 @@ - response_default_headers() -> [Header] + response_default_headers() -> [Header] Provide default headers for the HTTP servers responses. Header = {HeaderName :: string(), HeaderValue::string()} @@ -48,7 +48,7 @@ - response_header({HeaderName, HeaderValue}) -> {true, Header} | false + response_header({HeaderName, HeaderValue}) -> {true, Header} | false Filter and possible alter HTTP response headers. Header = {HeaderName :: string(), HeaderValue::string()} @@ -61,7 +61,7 @@ - request_header({HeaderName, HeaderValue}) -> {true, Header} | false + request_header({HeaderName, HeaderValue}) -> {true, Header} | false Filter and possible alter HTTP request headers. Header = {HeaderName :: string(), HeaderValue::string()} diff --git a/lib/inets/doc/src/mod_auth.xml b/lib/inets/doc/src/mod_auth.xml index c4f844622b..6400444601 100644 --- a/lib/inets/doc/src/mod_auth.xml +++ b/lib/inets/doc/src/mod_auth.xml @@ -241,7 +241,7 @@ list_users(Options) -> {ok, Users} | {error, Reason} - list_users(Port, Dir) -> {ok, Users} | {error, Reason} + list_users(Port, Dir) -> {ok, Users} | {error, Reason} list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} Lists users in the user database. diff --git a/lib/inets/doc/src/mod_security.xml b/lib/inets/doc/src/mod_security.xml index 6f3f3c048a..340705f697 100644 --- a/lib/inets/doc/src/mod_security.xml +++ b/lib/inets/doc/src/mod_security.xml @@ -129,8 +129,8 @@ - Module:event(What, Port, Dir, Data) -> ignored - Module:event(What, Address, Port, Dir, Data) -> ignored + Module:event(What, Port, Dir, Data) -> ignored + Module:event(What, Address, Port, Dir, Data) -> ignored Called whenever an event occurs in mod_security. What = atom() -- cgit v1.2.3