Mercurial > irccd
comparison doc/html/api/module/Irccd.Directory/function/remove.md @ 0:1158cffe5a5e
Initial import
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Mon, 08 Feb 2016 16:43:14 +0100 |
| parents | |
| children | 070a1ece2af6 |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:1158cffe5a5e |
|---|---|
| 1 --- | |
| 2 function: remove | |
| 3 summary: "Remove the directory optionally recursively." | |
| 4 synopsis: "Irccd.Directory.remove(path, recursive)" | |
| 5 arguments: | |
| 6 - "path, the path to the directory," | |
| 7 - "recursive, recursively or not (Optional, default: false)." | |
| 8 throws: "Any exception on error." | |
| 9 --- | |
| 10 | |
| 11 <div class="alert alert-warning" role="alert"> | |
| 12 **Warning**: use this function with care! | |
| 13 </div> |