Mercurial > irccd

annotate doc/html/api/module/Irccd.File/method/constructor.md @ 13:070a1ece2af6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 method: constructor
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Open a file specified by path with the specified mode."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "Irccd.File(path, mode) /* constructor */"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 arguments:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 - "path, the path to the file,"
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
7 - "mode, the mode string."
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
8 throws: "Any exception on error."
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
11 ## Mode
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
13 The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
14 about the mode string.
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
15
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
16 [fopen]: http://en.cppreference.com/w/cpp/io/c/fopen