diff doc/html/api/module/Irccd.File/method/constructor.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 diff
--- a/doc/html/api/module/Irccd.File/method/constructor.md	Wed Feb 10 14:18:15 2016 +0100
+++ b/doc/html/api/module/Irccd.File/method/constructor.md	Thu Feb 11 22:02:57 2016 +0100
@@ -4,14 +4,13 @@
 synopsis: "Irccd.File(path, mode) /* constructor */"
 arguments:
   - "path, the path to the file,"
-  - "mode, the mode, can be one of [abrwt]"
-throws: "Any exception on error"
+  - "mode, the mode string."
+throws: "Any exception on error."
 ---
 
-The mode string understands the following characters:
+## Mode
 
-  - **a**: append to the end of file,
-  - **b**: open in binary mode,
-  - **r**: open for reading,
-  - **w**: open for writing,
-  - **t**: truncate the file.
\ No newline at end of file
+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