Mercurial > irccd
view doc/html/api/module/Irccd.File/method/constructor.md @ 24:392778b6d3c9
Docs: arguments are now in bold, #423
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 16 Feb 2016 13:36:46 +0100 |
parents | 070a1ece2af6 |
children | 12dfbec74a9c |
line wrap: on
line source
--- method: constructor summary: "Open a file specified by path with the specified mode." synopsis: "Irccd.File(path, mode) /* constructor */" arguments: - "**path**: the path to the file," - "**mode**: the mode string." throws: "Any exception on error." --- ## Mode The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information about the mode string. [fopen]: http://en.cppreference.com/w/cpp/io/c/fopen