annotate doc/html/api/module/Irccd.File/Irccd.File.remove.md @ 422:186864e9f131

Docs: fix multiple slashes in documentation, closes #624
author David Demelier <markand@malikania.fr>
date Thu, 02 Feb 2017 13:55:32 +0100
parents 48676ca7071c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
263
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 function: remove
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 js: true
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 summary: "Remove the file at the specified path."
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 synopsis: "Irccd.File.remove(path)"
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 arguments:
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 - "**path**: the path to the file."
422
186864e9f131 Docs: fix multiple slashes in documentation, closes #624
David Demelier <markand@malikania.fr>
parents: 263
diff changeset
8 throws: "An [Irccd.SystemError](@baseurl@api/module/Irccd/index.html#types) on failures."
263
48676ca7071c Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ---