aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/string.xml
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2012-01-17 12:28:32 +0100
committerHans Bolinder <[email protected]>2012-01-27 14:52:39 +0100
commit037150979ff809df85757bd2b3f676e2e4c6be88 (patch)
treeb0f9f7abc8e8ed062152c30ec8d7b581aff47aea /lib/stdlib/doc/src/string.xml
parentccd194683f8be69c43839840ffa8687773215c59 (diff)
downloadotp-037150979ff809df85757bd2b3f676e2e4c6be88.tar.gz
otp-037150979ff809df85757bd2b3f676e2e4c6be88.tar.bz2
otp-037150979ff809df85757bd2b3f676e2e4c6be88.zip
Move types and specs from erl_bif_types.erl to modules
Diffstat (limited to 'lib/stdlib/doc/src/string.xml')
-rw-r--r--lib/stdlib/doc/src/string.xml26
1 files changed, 7 insertions, 19 deletions
diff --git a/lib/stdlib/doc/src/string.xml b/lib/stdlib/doc/src/string.xml
index 48867ffe72..549c871aed 100644
--- a/lib/stdlib/doc/src/string.xml
+++ b/lib/stdlib/doc/src/string.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>1996</year><year>2011</year>
+ <year>1996</year><year>2012</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -255,18 +255,12 @@ sub_string("Hello World", 4, 8).
</desc>
</func>
<func>
- <name>to_float(String) -> {Float,Rest} | {error,Reason} </name>
+ <name name="to_float" arity="1"/>
<fsummary>Returns a float whose text representation is the integers (ASCII values) in String.</fsummary>
- <type>
- <v>String = string()</v>
- <v>Float = float()</v>
- <v>Rest = string()</v>
- <v>Reason = no_float | not_a_list</v>
- </type>
<desc>
- <p>Argument <c>String</c> is expected to start with a valid text
+ <p>Argument <c><anno>String</anno></c> is expected to start with a valid text
represented float (the digits being ASCII values). Remaining characters
- in the string after the float are returned in <c>Rest</c>.</p>
+ in the string after the float are returned in <c><anno>Rest</anno></c>.</p>
<p>Example:</p>
<code type="none">
> {F1,Fs} = string:to_float("1.0-1.0e-1"),
@@ -280,18 +274,12 @@ sub_string("Hello World", 4, 8).
</desc>
</func>
<func>
- <name>to_integer(String) -> {Int,Rest} | {error,Reason} </name>
+ <name name="to_integer" arity="1"/>
<fsummary>Returns an integer whose text representation is the integers (ASCII values) in String.</fsummary>
- <type>
- <v>String = string()</v>
- <v>Int = integer()</v>
- <v>Rest = string()</v>
- <v>Reason = no_integer | not_a_list</v>
- </type>
<desc>
- <p>Argument <c>String</c> is expected to start with a valid text
+ <p>Argument <c><anno>String</anno></c> is expected to start with a valid text
represented integer (the digits being ASCII values). Remaining characters
- in the string after the integer are returned in <c>Rest</c>.</p>
+ in the string after the integer are returned in <c><anno>Rest</anno></c>.</p>
<p>Example:</p>
<code type="none">
> {I1,Is} = string:to_integer("33+22"),