diff doc/html/api/module/Irccd.Directory/index.md @ 0:1158cffe5a5e

Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 904ee87bc808
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/api/module/Irccd.Directory/index.md	Mon Feb 08 16:43:14 2016 +0100
@@ -0,0 +1,33 @@
+---
+module: Irccd.Directory
+summary: Open an read directories.
+---
+
+## Usage
+
+This module can be used to iterate, find, remove or create directories.
+
+Use this module with care.
+
+## Constants
+
+The following properties are defined:
+
+  - **Dot**: (int) list "." directory,
+  - **DotDot**: (int) list ".." directory,
+  - **TypeUnknown**: (int) unknown type file,
+  - **TypeDir**: (int) entry is a directory,
+  - **TypeFile**: (int) entry is a file,
+  - **TypeLink**: (int) entry is a link.
+
+## Functions
+
+  - [find](function/find.html)
+  - [mkdir](function/mkdir.html)
+  - [remove](function/remove.html)
+
+## Methods
+
+  - [(constructor)](method/constructor.html)
+  - [find](method/find.html)
+  - [remove](method/remove.html)