Documentation [_Stdio]: Added some doc.

93cfc8cc · Henrik (Grubba) Grubbström · acc6dd0c · 93cfc8cc
Commit 93cfc8cc authored May 17, 2020 by Henrik (Grubba) Grubbström
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 0 deletions

src/modules/_Stdio/file.cmod src/modules/_Stdio/file.cmod +8 -0

No files found.
--- a/src/modules/_Stdio/file.cmod
+++ b/src/modules/_Stdio/file.cmod
@@ -170,6 +170,14 @@ struct program *file_program;
 struct program *file_ref_program;

 /*! @module _Stdio
+ *!
+ *! Low-level I/O.
+ *!
+ *! This is usually NOT the module you want.
+ *! Try @[Stdio] instead.
+ *!
+ *! @seealso
+ *!   @[Stdio]
 */

 /*! @enum FileModeFlags