view doc/html/api/module/Irccd.Directory/function/remove.md @ 13:070a1ece2af6

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 392778b6d3c9
line wrap: on
line source

---
function: remove
summary: "Remove the directory optionally recursively."
synopsis: "Irccd.Directory.remove(path, recursive)"
arguments:
  - "path, the path to the directory,"
  - "recursive, recursively or not (Optional, default: false)."
throws: "Any exception on error."
---

## Remarks

<div class="alert alert-danger" role="alert">
**Danger**: use this function with care!
</div>