From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/inets/doc/src/httpd.xml | 24 ++++++++-------- lib/inets/doc/src/httpd_socket.xml | 8 +++--- lib/inets/doc/src/httpd_util.xml | 50 +++++++++++++++++----------------- lib/inets/doc/src/inets.xml | 20 +++++++------- lib/inets/doc/src/mod_alias.xml | 10 +++---- lib/inets/doc/src/mod_auth.xml | 56 +++++++++++++++++++------------------- lib/inets/doc/src/mod_esi.xml | 8 +++--- lib/inets/doc/src/mod_security.xml | 30 ++++++++++---------- 8 files changed, 103 insertions(+), 103 deletions(-) (limited to 'lib/inets') diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 1a203fae90..66369e8df9 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -29,7 +29,7 @@ 2.2 httpd.sgml - httpd + httpd HTTP server API @@ -874,8 +874,8 @@ text/plain asc txt - info(Pid) -> - info(Pid, Properties) -> [{Option, Value}] + info(Pid) -> + info(Pid, Properties) -> [{Option, Value}] Fetches information about the HTTP server. Properties = [property()] @@ -899,10 +899,10 @@ text/plain asc txt - info(Address, Port) -> - info(Address, Port, Profile) -> + info(Address, Port) -> + info(Address, Port, Profile) -> info(Address, Port, Profile, Properties) -> [{Option, Value}] - info(Address, Port, Properties) -> [{Option, Value}] + info(Address, Port, Properties) -> [{Option, Value}] Fetches information about the HTTP server. Address = ip_address() @@ -927,7 +927,7 @@ text/plain asc txt - reload_config(Config, Mode) -> ok | {error, Reason} + reload_config(Config, Mode) -> ok | {error, Reason} Reloads the HTTP server configuration without restarting the server. @@ -1051,7 +1051,7 @@ text/plain asc txt - Module:do(ModData)-> {proceed, OldData} | {proceed, NewData} | {break, NewData} | done + Module:do(ModData)-> {proceed, OldData} | {proceed, NewData} | {break, NewData} | done Called for each request to the web server. OldData = list() @@ -1105,7 +1105,7 @@ text/plain asc txt - Module:load(Line, AccIn)-> eof | ok | {ok, AccOut} | {ok, AccOut, {Option, Value}} | {ok, AccOut, [{Option, Value}]} | {error, Reason} + Module:load(Line, AccIn)-> eof | ok | {ok, AccOut} | {ok, AccOut, {Option, Value}} | {ok, AccOut, [{Option, Value}]} | {error, Reason} Converts a line in an Apache-like config file to an {Option, Value} tuple. @@ -1128,7 +1128,7 @@ text/plain asc txt - Module:remove(ConfigDB) -> ok | {error, Reason} + Module:remove(ConfigDB) -> ok | {error, Reason} Callback function that is called when the web server is closed. ConfigDB = ets_table() @@ -1143,7 +1143,7 @@ text/plain asc txt - Module:store({Option, Value}, Config)-> {ok, {Option, NewValue}} | {error, Reason} + Module:store({Option, Value}, Config)-> {ok, {Option, NewValue}} | {error, Reason} Checks the validity of the configuration options. Line = string() @@ -1171,7 +1171,7 @@ text/plain asc txt - parse_query(QueryString) -> [{Key,Value}] + parse_query(QueryString) -> [{Key,Value}] Parses incoming data to erl and eval scripts. QueryString = string() diff --git a/lib/inets/doc/src/httpd_socket.xml b/lib/inets/doc/src/httpd_socket.xml index d3aa82a540..22ead06f38 100644 --- a/lib/inets/doc/src/httpd_socket.xml +++ b/lib/inets/doc/src/httpd_socket.xml @@ -29,7 +29,7 @@ 2.2 httpd_socket.sgml - httpd_socket + httpd_socket Communication utility functions to be used by the Erlang web server API programmer. @@ -43,7 +43,7 @@ - deliver(SocketType, Socket, Data) -> Result + deliver(SocketType, Socket, Data) -> Result Sends binary data over socket. SocketType = socket_type() @@ -63,7 +63,7 @@ - peername(SocketType,Socket) -> {Port,IPAddress} + peername(SocketType,Socket) -> {Port,IPAddress} Returns the port and IP address of the remote socket. SocketType = socket_type() @@ -81,7 +81,7 @@ - resolve() -> HostName + resolve() -> HostName Returns the official name of the current host. HostName = string() diff --git a/lib/inets/doc/src/httpd_util.xml b/lib/inets/doc/src/httpd_util.xml index 220a2ede35..29971ba8ae 100644 --- a/lib/inets/doc/src/httpd_util.xml +++ b/lib/inets/doc/src/httpd_util.xml @@ -29,7 +29,7 @@ 2.2 httpd_util.sgml - httpd_util + httpd_util Miscellaneous utility functions to be used when implementing Erlang web server API modules. @@ -41,7 +41,7 @@ - convert_request_date(DateString) -> ErlDate|bad_date + convert_request_date(DateString) -> ErlDate|bad_date Converts the date to the Erlang date format. DateString = string() @@ -57,7 +57,7 @@ - create_etag(FileInfo) -> Etag + create_etag(FileInfo) -> Etag Calculates the Etag for a file. FileInfo = file_info() @@ -71,7 +71,7 @@ - day(NthDayOfWeek) -> DayOfWeek + day(NthDayOfWeek) -> DayOfWeek Converts the day of the week (integer [1-7]) to an abbreviated string. @@ -87,7 +87,7 @@ - decode_hex(HexValue) -> DecValue + decode_hex(HexValue) -> DecValue Converts a hexadecimal value into its decimal equivalent. HexValue = DecValue = string() @@ -99,7 +99,7 @@ - flatlength(NestedList) -> Size + flatlength(NestedList) -> Size Computes the size of a possibly nested list. NestedList = list() @@ -112,7 +112,7 @@ - hexlist_to_integer(HexString) -> Number + hexlist_to_integer(HexString) -> Number Converts a hexadecimal string to an integer. Number = integer() @@ -125,7 +125,7 @@ - integer_to_hexlist(Number) -> HexString + integer_to_hexlist(Number) -> HexString Converts an integer to a hexadecimal string. Number = integer() @@ -138,8 +138,8 @@ - lookup(ETSTable,Key) -> Result - lookup(ETSTable,Key,Undefined) -> Result + lookup(ETSTable,Key) -> Result + lookup(ETSTable,Key,Undefined) -> Result Extracts the first value associated with a Key in an ETS table. @@ -160,8 +160,8 @@ - lookup_mime(ConfigDB,Suffix) - lookup_mime(ConfigDB,Suffix,Undefined) -> MimeType + lookup_mime(ConfigDB,Suffix) + lookup_mime(ConfigDB,Suffix,Undefined) -> MimeType Returns the MIME type associated with a specific file suffix. ConfigDB = ets_table() @@ -179,8 +179,8 @@ - lookup_mime_default(ConfigDB,Suffix) - lookup_mime_default(ConfigDB,Suffix,Undefined) -> MimeType + lookup_mime_default(ConfigDB,Suffix) + lookup_mime_default(ConfigDB,Suffix,Undefined) -> MimeType Returns the MIME type associated with a specific file suffix or the value of the DefaultType. @@ -201,7 +201,7 @@ - message(StatusCode,PhraseArgs,ConfigDB) -> Message + message(StatusCode,PhraseArgs,ConfigDB) -> Message Returns an informative HTTP 1.1 status string in HTML. StatusCode = 301 | 400 | 403 | 404 | 500 | 501 | 504 @@ -236,7 +236,7 @@ - month(NthMonth) -> Month + month(NthMonth) -> Month Converts the month as an integer (1-12) to an abbreviated string. NthMonth = 1-12 @@ -250,7 +250,7 @@ - multi_lookup(ETSTable,Key) -> Result + multi_lookup(ETSTable,Key) -> Result Extracts the values associated with a key in an ETS table. ETSTable = ets_table() @@ -265,7 +265,7 @@ - reason_phrase(StatusCode) -> Description + reason_phrase(StatusCode) -> Description Returns the description of an HTTP 1.1 status code. StatusCode = 100| 200 | 201 | 202 | 204 | 205 | 206 | 300 | 301 | 302 | 303 | 304 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 410 411 | 412 | 413 | 414 415 | 416 | 417 | 500 | 501 | 502 | 503 | 504 | 505 @@ -280,8 +280,8 @@ - rfc1123_date() -> RFC1123Date - rfc1123_date({{YYYY,MM,DD},{Hour,Min,Sec}}) -> RFC1123Date + rfc1123_date() -> RFC1123Date + rfc1123_date({{YYYY,MM,DD},{Hour,Min,Sec}}) -> RFC1123Date Returns the current date in RFC 1123 format. YYYY = MM = DD = Hour = Min = Sec = integer() @@ -295,7 +295,7 @@ - split(String,RegExp,N) -> SplitRes + split(String,RegExp,N) -> SplitRes Splits a string in N chunks using a regular expression. String = RegExp = string() @@ -313,7 +313,7 @@ - split_script_path(RequestLine) -> Splitted + split_script_path(RequestLine) -> Splitted Splits a RequestLine in a file reference to an executable, and a QueryString or a PathInfostring. @@ -330,7 +330,7 @@ - split_path(RequestLine) -> {Path,QueryStringOrPathInfo} + split_path(RequestLine) -> {Path,QueryStringOrPathInfo} Splits a RequestLine in a file reference, and a QueryString or a PathInfo string. @@ -356,7 +356,7 @@ - strip(String) -> Stripped + strip(String) -> Stripped Returns String where the leading and trailing space tabs are removed. @@ -370,7 +370,7 @@ - suffix(FileName) -> Suffix + suffix(FileName) -> Suffix Extracts the file suffix from a given filename. FileName = Suffix = string() diff --git a/lib/inets/doc/src/inets.xml b/lib/inets/doc/src/inets.xml index 9b0ffaad5e..176af3137a 100644 --- a/lib/inets/doc/src/inets.xml +++ b/lib/inets/doc/src/inets.xml @@ -29,7 +29,7 @@ - inets + inets The Inets services API.

This module provides the most basic API to the @@ -51,7 +51,7 @@ - services() -> [{Service, Pid}] + services() -> [{Service, Pid}] Returns a list of currently running services. Service = service() @@ -68,7 +68,7 @@ - services_info() -> [{Service, Pid, Info}] + services_info() -> [{Service, Pid, Info}] Returns a list of currently running services where each service is described by an [{Option, Value}] list. @@ -91,7 +91,7 @@ - service_names() -> [Service] + service_names() -> [Service] Returns a list of available service names. Service = service() @@ -104,8 +104,8 @@ - start() -> - start(Type) -> ok | {error, Reason} + start() -> + start(Type) -> ok | {error, Reason} Starts the Inets application. Type = permanent | transient | temporary @@ -120,8 +120,8 @@ - start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason} - start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason} + start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason} + start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason} Dynamically starts an Inets service after the Inets application has been started. @@ -156,7 +156,7 @@ - stop() -> ok + stop() -> ok Stops the Inets application.

Stops the Inets application. See also @@ -167,7 +167,7 @@ - stop(Service, Reference) -> ok | {error, Reason} + stop(Service, Reference) -> ok | {error, Reason} Stops a started service of the Inets application or takes down a stand_alone service gracefully. diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index 6ae19700a5..ff57d49d08 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -29,7 +29,7 @@ 2.2 mod_alias.sgml - mod_alias + mod_alias URL aliasing.

Erlang web server internal API for handling of, for example, @@ -40,7 +40,7 @@ - default_index(ConfigDB, Path) -> NewPath + default_index(ConfigDB, Path) -> NewPath Returns a new path with the default resource or file appended. ConfigDB = config_db() @@ -64,7 +64,7 @@ - path(PathData, ConfigDB, RequestURI) -> Path + path(PathData, ConfigDB, RequestURI) -> Path Returns the file path to a URL. PathData = interaction_data() @@ -89,7 +89,7 @@ - real_name(ConfigDB, RequestURI, Aliases) -> Ret + real_name(ConfigDB, RequestURI, Aliases) -> Ret Expands a request URI using Aliases config directives. ConfigDB = config_db() @@ -120,7 +120,7 @@ - real_script_name(ConfigDB, RequestURI, ScriptAliases) -> Ret + real_script_name(ConfigDB, RequestURI, ScriptAliases) -> Ret Expands a request URI using ScriptAliases config directives. diff --git a/lib/inets/doc/src/mod_auth.xml b/lib/inets/doc/src/mod_auth.xml index 6400444601..ad864ca4d1 100644 --- a/lib/inets/doc/src/mod_auth.xml +++ b/lib/inets/doc/src/mod_auth.xml @@ -29,7 +29,7 @@ 2.3 mod_auth.sgml - mod_auth + mod_auth User authentication using text files, Dets, or Mnesia database.

This module provides for basic user authentication using @@ -38,9 +38,9 @@ - add_group_member(GroupName, UserName, Options) -> true | {error, Reason} - add_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} - add_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} + add_group_member(GroupName, UserName, Options) -> true | {error, Reason} + add_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} + add_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} Adds a user to a group. GroupName = string() @@ -65,9 +65,9 @@ - add_user(UserName, Options) -> true| {error, Reason} - add_user(UserName, Password, UserData, Port, Dir) -> true | {error, Reason} - add_user(UserName, Password, UserData, Address, Port, Dir) -> true | {error, Reason} + add_user(UserName, Options) -> true| {error, Reason} + add_user(UserName, Password, UserData, Port, Dir) -> true | {error, Reason} + add_user(UserName, Password, UserData, Address, Port, Dir) -> true | {error, Reason} Adds a user to the user database. UserName = string() @@ -92,8 +92,8 @@ - delete_group(GroupName, Options) -> true | {error,Reason} <name>delete_group(GroupName, Port, Dir) -> true | {error, Reason} - delete_group(GroupName, Address, Port, Dir) -> true | {error, Reason} + delete_group(GroupName, Options) -> true | {error,Reason} <name>delete_group(GroupName, Port, Dir) -> true | {error, Reason} + delete_group(GroupName, Address, Port, Dir) -> true | {error, Reason} Deletes a group. Options = [Option] @@ -115,9 +115,9 @@ - delete_group_member(GroupName, UserName, Options) -> true | {error, Reason} - delete_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} - delete_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} + delete_group_member(GroupName, UserName, Options) -> true | {error, Reason} + delete_group_member(GroupName, UserName, Port, Dir) -> true | {error, Reason} + delete_group_member(GroupName, UserName, Address, Port, Dir) -> true | {error, Reason} Removes a user from a group. GroupName = string() @@ -141,9 +141,9 @@ - delete_user(UserName,Options) -> true | {error, Reason} - delete_user(UserName, Port, Dir) -> true | {error, Reason} - delete_user(UserName, Address, Port, Dir) -> true | {error, Reason} + delete_user(UserName,Options) -> true | {error, Reason} + delete_user(UserName, Port, Dir) -> true | {error, Reason} + delete_user(UserName, Address, Port, Dir) -> true | {error, Reason} Deletes a user from the user database. UserName = string() @@ -166,9 +166,9 @@ - get_user(UserName,Options) -> {ok, #httpd_user} |{error, Reason} - get_user(UserName, Port, Dir) -> {ok, #httpd_user} | {error, Reason} - get_user(UserName, Address, Port, Dir) -> {ok, #httpd_user} | {error, Reason} + get_user(UserName,Options) -> {ok, #httpd_user} |{error, Reason} + get_user(UserName, Port, Dir) -> {ok, #httpd_user} | {error, Reason} + get_user(UserName, Address, Port, Dir) -> {ok, #httpd_user} | {error, Reason} Returns a user from the user database. UserName = string() @@ -190,9 +190,9 @@ - list_groups(Options) -> {ok, Groups} | {error, Reason} - list_groups(Port, Dir) -> {ok, Groups} | {error, Reason} - list_groups(Address, Port, Dir) -> {ok, Groups} | {error, Reason} + list_groups(Options) -> {ok, Groups} | {error, Reason} + list_groups(Port, Dir) -> {ok, Groups} | {error, Reason} + list_groups(Address, Port, Dir) -> {ok, Groups} | {error, Reason} Lists all the groups. Options = [Option] @@ -214,9 +214,9 @@ - list_group_members(GroupName, Options) -> {ok, Users} | {error, Reason} - list_group_members(GroupName, Port, Dir) -> {ok, Users} | {error, Reason} - list_group_members(GroupName, Address, Port, Dir) -> {ok, Users} | {error, Reason} + list_group_members(GroupName, Options) -> {ok, Users} | {error, Reason} + list_group_members(GroupName, Port, Dir) -> {ok, Users} | {error, Reason} + list_group_members(GroupName, Address, Port, Dir) -> {ok, Users} | {error, Reason} Lists the members of a group. GroupName = string() @@ -240,9 +240,9 @@ - list_users(Options) -> {ok, Users} | {error, Reason} + list_users(Options) -> {ok, Users} | {error, Reason} list_users(Port, Dir) -> {ok, Users} | {error, Reason} - list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} + list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} Lists users in the user database. Options = [Option] @@ -264,8 +264,8 @@ - update_password(Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} - update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} + update_password(Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} + update_password(Address,Port, Dir, OldPassword, NewPassword, NewPassword) -> ok | {error, Reason} Changes AuthAcessPassword. Port = integer() diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml index ede7dc8f7d..bc5f98068f 100644 --- a/lib/inets/doc/src/mod_esi.xml +++ b/lib/inets/doc/src/mod_esi.xml @@ -25,7 +25,7 @@ mod_esi mod_esi.sgml - mod_esi + mod_esi Erlang Server Interface

This module defines the Erlang Server Interface (ESI) API. @@ -88,7 +88,7 @@ - deliver(SessionID, Data) -> ok | {error, Reason} + deliver(SessionID, Data) -> ok | {error, Reason} Sends Data back to client. SessionID = term() @@ -121,7 +121,7 @@ - Module:Function(SessionID, Env, Input)-> {continue, State} | _ + Module:Function(SessionID, Env, Input)-> {continue, State} | _ Creates a dynamic web page and returns it chunk by chunk to the server process by calling mod_esi:deliver/2. @@ -179,7 +179,7 @@ - Module:Function(Env, Input)-> Response + Module:Function(Env, Input)-> Response Creates a dynamic web page and returns it as a list. This function is deprecated and is only kept for backwards compatibility. diff --git a/lib/inets/doc/src/mod_security.xml b/lib/inets/doc/src/mod_security.xml index 340705f697..c26d7468c2 100644 --- a/lib/inets/doc/src/mod_security.xml +++ b/lib/inets/doc/src/mod_security.xml @@ -29,7 +29,7 @@ 1.0 mod_security.sgml - mod_security + mod_security Security Audit and Trailing Functionality

Security Audit and Trailing Functionality

@@ -37,8 +37,8 @@ - block_user(User, Port, Dir, Seconds) -> true | {error, Reason} - block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason} + block_user(User, Port, Dir, Seconds) -> true | {error, Reason} + block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason} Blocks a user from access to a directory for a certain amount of time. User = string() @@ -56,10 +56,10 @@ - list_auth_users(Port) -> Users | [] - list_auth_users(Address, Port) -> Users | [] - list_auth_users(Port, Dir) -> Users | [] - list_auth_users(Address, Port, Dir) -> Users | [] + list_auth_users(Port) -> Users | [] + list_auth_users(Address, Port) -> Users | [] + list_auth_users(Port, Dir) -> Users | [] + list_auth_users(Address, Port, Dir) -> Users | [] Lists users that have authenticated within the SecurityAuthTimeout time for a given address (if specified), port number, and directory (if specified). @@ -77,10 +77,10 @@ - list_blocked_users(Port) -> Users | [] - list_blocked_users(Address, Port) -> Users | [] - list_blocked_users(Port, Dir) -> Users | [] - list_blocked_users(Address, Port, Dir) -> Users | [] + list_blocked_users(Port) -> Users | [] + list_blocked_users(Address, Port) -> Users | [] + list_blocked_users(Port, Dir) -> Users | [] + list_blocked_users(Address, Port, Dir) -> Users | [] Lists users that are currently blocked from access to a specified port number, for a given address (if specified). @@ -97,10 +97,10 @@ - unblock_user(User, Port) -> true | {error, Reason} - unblock_user(User, Address, Port) -> true | {error, Reason} - unblock_user(User, Port, Dir) -> true | {error, Reason} - unblock_user(User, Address, Port, Dir) -> true | {error, Reason} + unblock_user(User, Port) -> true | {error, Reason} + unblock_user(User, Address, Port) -> true | {error, Reason} + unblock_user(User, Port, Dir) -> true | {error, Reason} + unblock_user(User, Address, Port, Dir) -> true | {error, Reason} Removes a blocked user from the block list. User = string() -- cgit v1.2.3