aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/filelib.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2011-05-18 16:21:34 +0200
committerLukas Larsson <[email protected]>2011-05-18 16:21:34 +0200
commit15426ac367eed736c165a5bdbb1c051a87944f68 (patch)
treefcabce7847168a8416600fe35f94a411a5f73d6e /lib/stdlib/doc/src/filelib.xml
parent4cd0717b717803ce8f03a12de4bf89f452ed1df7 (diff)
parentf44bbb331fb517e989d4d906b7f63ec110bbbc18 (diff)
downloadotp-15426ac367eed736c165a5bdbb1c051a87944f68.tar.gz
otp-15426ac367eed736c165a5bdbb1c051a87944f68.tar.bz2
otp-15426ac367eed736c165a5bdbb1c051a87944f68.zip
Merge branch 'dev' of super:otp into dev
* 'dev' of super:otp: (166 commits) Corrected documentation error and added examples to Users Guide In TLS 1.1, failure to properly close a connection no longer requires that a session not be resumed. This is a change from TLS 1.0 to conform with widespread implementation practice. Erlang ssl will now in TLS 1.0 conform to the widespread implementation practice instead of the specification to avoid performance issues. Add escript to bootstrap/bin Remove unused variable warning in inet_res Remove unused variable in epmd_port Remove compiler warnings in inet_drv Add SASL test suite Allow same module name in multiple applications if explicitely excluded Fix bugs concerning the option report_missing_types Fix default encoding in SAX parser. re: remove gratuitous "it " in manpage Spelling in (backward *compatibility*) comment. Improve erl_docgen's support for Dialyzer specs and types dialyzer warning on mnesia_tm Add documentation text about majority checking add mnesia_majority_test suite where_to_wlock optimization + change_table_majority/2 bug in mnesia_tm:needs_majority/2 optimize sticky_lock maj. check check majority for sticky locks ...
Diffstat (limited to 'lib/stdlib/doc/src/filelib.xml')
-rw-r--r--lib/stdlib/doc/src/filelib.xml89
1 files changed, 27 insertions, 62 deletions
diff --git a/lib/stdlib/doc/src/filelib.xml b/lib/stdlib/doc/src/filelib.xml
index fab68ae77c..f3079c7337 100644
--- a/lib/stdlib/doc/src/filelib.xml
+++ b/lib/stdlib/doc/src/filelib.xml
@@ -41,62 +41,46 @@
<p>For more information about raw file names, see the <seealso marker="kernel:file">file</seealso> module.</p>
</description>
- <section>
- <title>DATA TYPES</title>
- <code type="none">
-filename() = string() | atom() | DeepList | RawFilename
- DeepList = [char() | atom() | DeepList]
- RawFilename = binary()
- If VM is in unicode filename mode, string() and char() are allowed to be > 255.
- RawFilename is a filename not subject to Unicode translation, meaning that it
- can contain characters not conforming to the Unicode encoding expected from the
- filesystem (i.e. non-UTF-8 characters although the VM is started in Unicode
- filename mode).
-dirname() = filename()</code>
- </section>
+ <datatypes>
+ <datatype>
+ <name name="filename"/>
+ </datatype>
+ <datatype>
+ <name name="dirname"/>
+ </datatype>
+ </datatypes>
<funcs>
<func>
- <name>ensure_dir(Name) -> ok | {error, Reason}</name>
+ <name name="ensure_dir" arity="1"/>
<fsummary>Ensure that all parent directories for a file or directory exist.</fsummary>
- <type>
- <v>Name = filename() | dirname()</v>
- <v>Reason = posix() -- see file(3)</v>
- </type>
<desc>
<p>The <c>ensure_dir/1</c> function ensures that all parent
- directories for the given file or directory name <c>Name</c>
+ directories for the given file or directory name <c><anno>Name</anno></c>
exist, trying to create them if necessary.</p>
<p>Returns <c>ok</c> if all parent directories already exist
- or could be created, or <c>{error, Reason}</c> if some parent
+ or could be created, or <c>{error, <anno>Reason</anno>}</c> if some parent
directory does not exist and could not be created for some
reason.</p>
</desc>
</func>
<func>
- <name>file_size(Filename) -> integer()</name>
+ <name name="file_size" arity="1"/>
<fsummary>Return the size in bytes of the file.</fsummary>
<desc>
<p>The <c>file_size</c> function returns the size of the given file.</p>
</desc>
</func>
<func>
- <name>fold_files(Dir, RegExp, Recursive, Fun, AccIn) -> AccOut </name>
+ <name name="fold_files" arity="5"/>
<fsummary>Fold over all files matching a regular expression.</fsummary>
- <type>
- <v>Dir = dirname()</v>
- <v>RegExp = regular_expression_string()</v>
- <v>Recursive = true|false</v>
- <v>Fun = fun(F, AccIn) -> AccOut</v>
- <v>AccIn = AccOut = term()</v>
- </type>
<desc>
<p>The <c>fold_files/5</c> function folds the function
- <c>Fun</c> over all (regular) files <c>F</c> in the
- directory <c>Dir</c> that match the regular expression <c>RegExp</c>
+ <c><anno>Fun</anno></c> over all (regular) files <c><anno>F</anno></c> in the
+ directory <c><anno>Dir</anno></c> that match the regular expression <c><anno>RegExp</anno></c>
(see the <seealso marker="re">re</seealso> module for a description
of the allowed regular expressions).
- If <c>Recursive</c> is true all sub-directories to <c>Dir</c>
+ If <c><anno>Recursive</anno></c> is true all sub-directories to <c>Dir</c>
are processed. The regular expression matching is done on just
the filename without the directory part.</p>
@@ -114,44 +98,32 @@ dirname() = filename()</code>
</desc>
</func>
<func>
- <name>is_dir(Name) -> true | false</name>
+ <name name="is_dir" arity="1"/>
<fsummary>Test whether Name refer to a directory or not</fsummary>
- <type>
- <v>Name = filename() | dirname()</v>
- </type>
<desc>
- <p>The <c>is_dir/1</c> function returns <c>true</c> if <c>Name</c>
+ <p>The <c>is_dir/1</c> function returns <c>true</c> if <c><anno>Name</anno></c>
refers to a directory, and <c>false</c> otherwise.</p>
</desc>
</func>
<func>
- <name>is_file(Name) -> true | false</name>
+ <name name="is_file" arity="1"/>
<fsummary>Test whether Name refer to a file or directory.</fsummary>
- <type>
- <v>Name = filename() | dirname()</v>
- </type>
<desc>
- <p>The <c>is_file/1</c> function returns <c>true</c> if <c>Name</c>
+ <p>The <c>is_file/1</c> function returns <c>true</c> if <c><anno>Name</anno></c>
refers to a file or a directory, and <c>false</c> otherwise.</p>
</desc>
</func>
<func>
- <name>is_regular(Name) -> true | false</name>
+ <name name="is_regular" arity="1"/>
<fsummary>Test whether Name refer to a (regular) file.</fsummary>
- <type>
- <v>Name = filename()</v>
- </type>
<desc>
- <p>The <c>is_regular/1</c> function returns <c>true</c> if <c>Name</c>
+ <p>The <c>is_regular/1</c> function returns <c>true</c> if <c><anno>Name</anno></c>
refers to a file (regular file), and <c>false</c> otherwise.</p>
</desc>
</func>
<func>
- <name>last_modified(Name) -> {{Year,Month,Day},{Hour,Min,Sec}} | 0</name>
+ <name name="last_modified" arity="1"/>
<fsummary>Return the local date and time when a file was last modified.</fsummary>
- <type>
- <v>Name = filename() | dirname()</v>
- </type>
<desc>
<p>The <c>last_modified/1</c> function returns the date and time the
given file or directory was last modified, or 0 if the file
@@ -159,14 +131,11 @@ dirname() = filename()</code>
</desc>
</func>
<func>
- <name>wildcard(Wildcard) -> list()</name>
+ <name name="wildcard" arity="1"/>
<fsummary>Match filenames using Unix-style wildcards.</fsummary>
- <type>
- <v>Wildcard = filename() | dirname()</v>
- </type>
<desc>
<p>The <c>wildcard/1</c> function returns a list of all files
- that match Unix-style wildcard-string <c>Wildcard</c>.</p>
+ that match Unix-style wildcard-string <c><anno>Wildcard</anno></c>.</p>
<p>The wildcard string looks like an ordinary filename, except
that certain "wildcard characters" are interpreted in a special
way. The following characters are special:
@@ -226,15 +195,11 @@ dirname() = filename()</code>
</desc>
</func>
<func>
- <name>wildcard(Wildcard, Cwd) -> list()</name>
+ <name name="wildcard" arity="2"/>
<fsummary>Match filenames using Unix-style wildcards starting at a specified directory.</fsummary>
- <type>
- <v>Wildcard = filename() | dirname()</v>
- <v>Cwd = dirname()</v>
- </type>
<desc>
<p>The <c>wildcard/2</c> function works like <c>wildcard/1</c>,
- except that instead of the actual working directory, <c>Cwd</c>
+ except that instead of the actual working directory, <c><anno>Cwd</anno></c>
will be used.</p>
</desc>
</func>