Mercurial > irccd

annotate doc/html/api/module/Irccd.Directory/index.md @ 13:070a1ece2af6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: fix various errors in JavaScript API
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 22:02:57 +0100
parents 1158cffe5a5e
children 904ee87bc808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 module: Irccd.Directory
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: Open an read directories.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 This module can be used to iterate, find, remove or create directories.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 Use this module with care.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 ## Constants
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 The following properties are defined:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 - **Dot**: (int) list "." directory,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 - **DotDot**: (int) list ".." directory,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 - **TypeUnknown**: (int) unknown type file,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 - **TypeDir**: (int) entry is a directory,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 - **TypeFile**: (int) entry is a file,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 - **TypeLink**: (int) entry is a link.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 ## Functions
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 - [find](function/find.html)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 - [mkdir](function/mkdir.html)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 - [remove](function/remove.html)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 ## Methods
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 - [(constructor)](method/constructor.html)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 - [find](method/find.html)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 - [remove](method/remove.html)