aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/ms_transform.xml
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2011-05-13 14:08:25 +0200
committerHans Bolinder <[email protected]>2011-05-13 14:08:59 +0200
commit0ccc57b1e3772deaf5650077808a38a52b1133b9 (patch)
treeed98a14e3cda51c344a04c85db7843b274dfe56a /lib/stdlib/doc/src/ms_transform.xml
parent22f3c9720cb7d19a3aafac613f03aede91d6283f (diff)
parent229d0d8ca88bc344bed89e46541b325c1d267996 (diff)
downloadotp-0ccc57b1e3772deaf5650077808a38a52b1133b9.tar.gz
otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.tar.bz2
otp-0ccc57b1e3772deaf5650077808a38a52b1133b9.zip
Merge branch 'hb/stdlib/doc_specs/OTP-9271' into dev
* hb/stdlib/doc_specs/OTP-9271: Use Erlang specs and types for documentation Conflicts: lib/stdlib/doc/src/timer.xml
Diffstat (limited to 'lib/stdlib/doc/src/ms_transform.xml')
-rw-r--r--lib/stdlib/doc/src/ms_transform.xml25
1 files changed, 7 insertions, 18 deletions
diff --git a/lib/stdlib/doc/src/ms_transform.xml b/lib/stdlib/doc/src/ms_transform.xml
index ba9f89685b..f81f8bda96 100644
--- a/lib/stdlib/doc/src/ms_transform.xml
+++ b/lib/stdlib/doc/src/ms_transform.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2002</year><year>2010</year>
+ <year>2002</year><year>2011</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -599,12 +599,9 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]).</code>
</description>
<funcs>
<func>
- <name>parse_transform(Forms,_Options) -> Forms</name>
+ <name name="parse_transform" arity="2"/>
<fsummary>Transforms Erlang abstract format containing calls to ets/dbg:fun2ms into literal match specifications.</fsummary>
- <type>
- <v>Forms = Erlang abstract code format, see the erl_parse module description </v>
- <v>_Options = Option list, required but not used</v>
- </type>
+ <type_desc variable="Options">Option list, required but not used.</type_desc>
<desc>
<p>Implements the actual transformation at compile time. This
function is called by the compiler to do the source code
@@ -617,29 +614,21 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]).</code>
</desc>
</func>
<func>
- <name>transform_from_shell(Dialect,Clauses,BoundEnvironment) -> term()</name>
+ <name name="transform_from_shell" arity="3"/>
<fsummary>Used when transforming fun's created in the shell into match_specifications.</fsummary>
- <type>
- <v>Dialect = ets | dbg</v>
- <v>Clauses = Erlang abstract form for a single fun</v>
- <v>BoundEnvironment = [{atom(), term()}, ...], list of variable bindings in the shell environment</v>
- </type>
+ <type_desc variable="BoundEnvironment">List of variable bindings in the shell environment.</type_desc>
<desc>
<p>Implements the actual transformation when the <c>fun2ms</c>
functions are called from the shell. In this case the abstract
form is for one single fun (parsed by the Erlang shell), and
all imported variables should be in the key-value list passed
- as <c>BoundEnvironment</c>. The result is a term, normalized,
+ as <c><anno>BoundEnvironment</anno></c>. The result is a term, normalized,
i.e. not in abstract format.</p>
</desc>
</func>
<func>
- <name>format_error(Errcode) -> ErrMessage</name>
+ <name name="format_error" arity="1"/>
<fsummary>Error formatting function as required by the parse_transform interface.</fsummary>
- <type>
- <v>Errcode = term()</v>
- <v>ErrMessage = string()</v>
- </type>
<desc>
<p>Takes an error code returned by one of the other functions
in the module and creates a textual description of the