aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc
diff options
context:
space:
mode:
authorPierre Fenoll <[email protected]>2013-12-19 14:36:06 +0000
committerLukas Larsson <[email protected]>2014-03-27 10:07:34 +0100
commitbe34551be2119a6c3c1a7edf113b7db12789423b (patch)
treeb189873009476617d1e8e8ca058e187fbd62edb5 /lib/stdlib/doc
parent25237481ccccd3ddfa74582dc267632ad618ba30 (diff)
downloadotp-be34551be2119a6c3c1a7edf113b7db12789423b.tar.gz
otp-be34551be2119a6c3c1a7edf113b7db12789423b.tar.bz2
otp-be34551be2119a6c3c1a7edf113b7db12789423b.zip
Document an escript:create/2 hidden feature
escript:create/2 accepts a 3-elements tuple containing files and zip:create/3 options to build a zip file. Also had to update zip typespecs to allow referral from escript docs.
Diffstat (limited to 'lib/stdlib/doc')
-rw-r--r--lib/stdlib/doc/src/zip.xml13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml
index 484bf0e080..d7c655672d 100644
--- a/lib/stdlib/doc/src/zip.xml
+++ b/lib/stdlib/doc/src/zip.xml
@@ -123,6 +123,18 @@
</taglist>
</desc>
</datatype>
+ <datatype>
+ <name name="filename"/>
+ <p>The name of a zip file.</p>
+ </datatype>
+ <datatype><name name="extension"/></datatype>
+ <datatype><name name="extension_spec"/></datatype>
+ <datatype>
+ <name name="create_option"/>
+ <desc>
+ <p>These options are described in <seealso marker="#zip_options">create/3</seealso>.</p>
+ </desc>
+ </datatype>
</datatypes>
<funcs>
<func>
@@ -160,6 +172,7 @@
set to <c>["gif", "jpg"]</c> and <c>uncompress</c> is set to
<c>["jpg"]</c>, only files with <c>"gif"</c> as extension will
be compressed. No other files will be compressed.</p>
+ <marker id="zip_options"></marker>
<p>The following options are available:</p>
<taglist>
<tag><c>cooked</c></tag>