summaryrefslogtreecommitdiff
path: root/lib/inets/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'lib/inets/doc/src')
-rw-r--r--lib/inets/doc/src/http_uri.xml51
-rw-r--r--lib/inets/doc/src/httpc.xml8
-rw-r--r--lib/inets/doc/src/httpd_util.xml87
3 files changed, 32 insertions, 114 deletions
diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml
index 39b367eb92..41f6271a0d 100644
--- a/lib/inets/doc/src/http_uri.xml
+++ b/lib/inets/doc/src/http_uri.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2012</year><year>2022</year>
+ <year>2012</year><year>2023</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -42,53 +42,46 @@
<section>
<title>DATA TYPES</title>
- <p>Type definitions that are used more than once in
- this module:</p>
- <p><c>boolean() = true | false</c></p>
- <p><c>string()</c> = list of ASCII characters</p>
-
- </section>
-
- <section>
- <title>URI DATA TYPES</title>
<p>Type definitions that are related to URI:</p>
-<taglist>
- <tag><c>uri() = string() | binary()</c></tag>
- <item><p>Syntax according to the URI definition in RFC 3986,
- for example, "http://www.erlang.org/"</p></item>
- </taglist>
-
- <p>For more information about URI, see
- <url href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</url>.</p>
+ <taglist>
+ <tag><c>uri_part() = [byte()] | binary()</c></tag>
+ <item><p>Syntax according to the URI definition in RFC 3986,
+ for example, "http://www.erlang.org/"</p></item>
+ </taglist>
+
+ <p>For more information about URI, see
+ <url href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</url>.</p>
</section>
<funcs>
<func>
- <name since="OTP R15B01">decode(HexEncodedURI) -> URI</name>
+ <name since="OTP R15B01">decode(EncodedPart) -> DecodePart</name>
- <fsummary>Decodes a hexadecimal encoded URI.</fsummary>
- <type>
- <v>HexEncodedURI = string() | binary() - A possibly hexadecimal encoded URI</v>
- <v>URI = uri()</v>
+ <fsummary>Decodes a percent encoded URI part.</fsummary>
+ <type>
+ <v>EncodedPart = uri_part() - A possibly percent encoded URI part</v>
+ <v>DecodePart = uri_part()</v>
</type>
<desc>
- <p>Decodes a possibly hexadecimal encoded URI.</p>
+ <warning><p>Do not use will be removed use <seemfa marker="stdlib:uri_string#unquote/1">uri_string:unquote/1</seemfa> instead </p></warning>
+ <p>Decodes a possibly percent encoded URI part</p>
</desc>
</func>
<func>
- <name since="OTP R15B01">encode(URI) -> HexEncodedURI</name>
+ <name since="OTP R15B01">encode(DecodedPart) -> EncodedPart</name>
- <fsummary>Encodes a hexadecimal encoded URI.</fsummary>
+ <fsummary>Performes percent encoding</fsummary>
<type>
- <v>URI = uri()</v>
- <v>HexEncodedURI = string() | binary() - Hexadecimal encoded URI</v>
+ <v>DecodePart = uri_part()</v>
+ <v>EncodedPart = uri_part() - Percent encoded URI part</v>
</type>
<desc>
- <p>Encodes a hexadecimal encoded URI.</p>
+ <warning><p>Do not use will be removed use <seemfa marker="stdlib:uri_string#quote/1">uri_string:quote/1</seemfa> instead </p> </warning>
+ <p>Performes prrcent encoding.</p>
<marker id="decode"></marker>
</desc>
diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 0c6437ccec..ba18c7d802 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -243,8 +243,12 @@
<tag><c>ssl</c></tag>
<item>
<p>This is the <c>SSL/TLS</c> connecting configuration option.</p>
- <p>Defaults to <c>[]</c>. See <seeerl marker="ssl:ssl">ssl:connect/[2,3,4]</seeerl> for available options.</p>
- </item>
+ <p>Default value is obtained by calling
+ <seemfa marker="#ssl_verify_host_options/1"><c>httpc:ssl_verify_host_options(true)</c>.
+ </seemfa>.
+ See <seeerl marker="ssl:ssl">ssl:connect/[2,3,4]</seeerl> for available options.
+ </p>
+ </item>
<tag><c>autoredirect</c></tag>
<item>
diff --git a/lib/inets/doc/src/httpd_util.xml b/lib/inets/doc/src/httpd_util.xml
index a334ec9f86..f8bd403efa 100644
--- a/lib/inets/doc/src/httpd_util.xml
+++ b/lib/inets/doc/src/httpd_util.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>1997</year><year>2022</year>
+ <year>1997</year><year>2023</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -87,57 +87,6 @@
</func>
<func>
- <name since="">decode_hex(HexValue) -> DecValue</name>
- <fsummary>Converts a hexadecimal value into its decimal equivalent.</fsummary>
- <type>
- <v>HexValue = DecValue = string()</v>
- </type>
- <desc>
- <p>Converts the hexadecimal value <c>HexValue</c> into its
- decimal equivalent (<c>DecValue</c>).</p>
- </desc>
- </func>
-
- <func>
- <name since="">flatlength(NestedList) -> Size</name>
- <fsummary>Computes the size of a possibly nested list.</fsummary>
- <type>
- <v>NestedList = list()</v>
- <v>Size = integer()</v>
- </type>
- <desc>
- <p><c>flatlength/1</c> computes the size of the possibly nested
- list <c>NestedList</c>, which can contain binaries.</p>
- </desc>
- </func>
-
- <func>
- <name since="">hexlist_to_integer(HexString) -> Number</name>
- <fsummary>Converts a hexadecimal string to an integer.</fsummary>
- <type>
- <v>Number = integer()</v>
- <v>HexString = string()</v>
- </type>
- <desc>
- <p><c>hexlist_to_integer</c> converts the hexadecimal value of
- <c>HexString</c> to an integer.</p>
- </desc>
- </func>
-
- <func>
- <name since="">integer_to_hexlist(Number) -> HexString</name>
- <fsummary>Converts an integer to a hexadecimal string.</fsummary>
- <type>
- <v>Number = integer()</v>
- <v>HexString = string()</v>
- </type>
- <desc>
- <p><c>integer_to_hexlist/1</c> returns a string representing
- <c>Number</c> in a hexadecimal form.</p>
- </desc>
- </func>
-
- <func>
<name since="">lookup(ETSTable,Key) -> Result</name>
<name since="">lookup(ETSTable,Key,Undefined) -> Result</name>
<fsummary>Extracts the first value associated with a <c>Key</c>
@@ -349,39 +298,11 @@
for longest possible <c>Path</c> being a file or a
directory. Everything after the longest possible
<c>Path</c>, isolated with a <c>/</c>, is regarded as
- <c>PathInfo</c>. The resulting <c>Path</c> is decoded using
- <c>decode_hex/1</c> before delivery.</p>
- </desc>
- </func>
-
- <func>
- <name since="">strip(String) -> Stripped</name>
- <fsummary>Returns <c>String</c> where the leading and trailing space
- tabs are removed.</fsummary>
- <type>
- <v>String = Stripped = string()</v>
- </type>
- <desc>
- <p><c>strip/1</c> removes any leading or trailing linear white
- space from the string. Linear white space is to be read as
- horizontal tab or space.</p>
+ <c>PathInfo</c></p>
</desc>
</func>
-
- <func>
- <name since="">suffix(FileName) -> Suffix</name>
- <fsummary>Extracts the file suffix from a given filename.</fsummary>
- <type>
- <v>FileName = Suffix = string()</v>
- </type>
- <desc>
- <p><c>suffix/1</c> is equivalent to
- <c>filename:extension/1</c> with the exception that
- <c>Suffix</c> is returned without a leading dot (<c>.</c>).</p>
- </desc>
- </func>
- </funcs>
-
+ </funcs>
+
<section>
<title>SEE ALSO</title>
<p><seeerl marker="httpd">httpd(3)</seeerl></p>