aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc/src
diff options
context:
space:
mode:
authorAnders Svensson <[email protected]>2013-09-23 10:31:21 +0200
committerAnders Svensson <[email protected]>2013-11-28 17:27:27 +0100
commit265c88664b93f9069c86bf6c25e5d07b7f41d2dc (patch)
treed5fdb9c37a57108d3e3a14fd2d4089df33923b4f /lib/diameter/doc/src
parent5682e18c8a31e3c32e9abd41120b2c1ae4c6930f (diff)
downloadotp-265c88664b93f9069c86bf6c25e5d07b7f41d2dc.tar.gz
otp-265c88664b93f9069c86bf6c25e5d07b7f41d2dc.tar.bz2
otp-265c88664b93f9069c86bf6c25e5d07b7f41d2dc.zip
Extend diameter_make:codec/2
Function can now take a literal dictionary as input, instead of a path, and can return results instead of writing them to the filesystem.
Diffstat (limited to 'lib/diameter/doc/src')
-rw-r--r--lib/diameter/doc/src/diameter_make.xml19
1 files changed, 18 insertions, 1 deletions
diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml
index ec71251be1..2e69fca1ae 100644
--- a/lib/diameter/doc/src/diameter_make.xml
+++ b/lib/diameter/doc/src/diameter_make.xml
@@ -64,12 +64,15 @@ interface.</p>
<funcs>
<func>
-<name>codec(Path::string(), [Opt]) -> ok | {error, Reason}</name>
+<name>codec(File :: iolist() | binary(), [Opt]) -> ok | {ok, Ret} | {error, Reason}</name>
<fsummary>Compile a dictionary file into Erlang source.</fsummary>
<desc>
<p>
Compile a single dictionary file to Erlang source.
+The input <c>File</c> can be either a path or a literal dictionary,
+the occurrence of newline (ascii NL) or carriage return (ascii CR)
+identifying the latter.
<c>Opt</c> can have the following types.</p>
<taglist>
@@ -93,6 +96,13 @@ Write generated source to the specified directory.
Defaults to the current working directory.</p>
</item>
+<tag><c>return</c></tag>
+<item>
+<p>
+Return erl and hrl source as two iolists rather than writing them to
+the filesystem.</p>
+</item>
+
<tag><c>{name|prefix, string()}</c></tag>
<item>
<p>
@@ -127,6 +137,13 @@ Multiple <c>inherits</c> options can be specified.</p>
</taglist>
+<p>
+Note that a dictionary's <c>&dict_name;</c>, together with the
+<c>outdir</c> option, determine the output paths when the
+<c>return</c> option is not specified.
+The <c>&dict_name;</c> of a literal input dictionary defaults to
+<c>dictionary</c>.</p>
+
</desc>
</func>