Mercurial > irccd
comparison doc/html/api/module/Irccd.File/method/constructor.md @ 27:12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 20 Feb 2016 10:35:43 +0100 |
parents | 392778b6d3c9 |
children | 904ee87bc808 |
comparison
equal
deleted
inserted
replaced
26:cdc91b663087 | 27:12dfbec74a9c |
---|---|
3 summary: "Open a file specified by path with the specified mode." | 3 summary: "Open a file specified by path with the specified mode." |
4 synopsis: "Irccd.File(path, mode) /* constructor */" | 4 synopsis: "Irccd.File(path, mode) /* constructor */" |
5 arguments: | 5 arguments: |
6 - "**path**: the path to the file," | 6 - "**path**: the path to the file," |
7 - "**mode**: the mode string." | 7 - "**mode**: the mode string." |
8 throws: "Any exception on error." | 8 throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." |
9 --- | 9 --- |
10 | 10 |
11 ## Mode | 11 ## Mode |
12 | 12 |
13 The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information | 13 The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information |