Browse Source

Added module.md for std and monkey.

Mark Sibly 9 years ago
parent
commit
dd6454c90e
2 changed files with 21 additions and 1 deletions
  1. 1 1
      modules/monkey/docs/module.md
  2. 20 0
      modules/std/docs/module.md

+ 1 - 1
modules/monkey/docs/module.md

@@ -3,5 +3,5 @@
 
 The monkey module provides core functionality required by all monkey apps.
 
-You don't need to #import the monkey module - this is done for automatically by the monkey2 compiler.
+You don't need to import the monkey module as it is implictly imported by all monkey code.
 

+ 20 - 0
modules/std/docs/module.md

@@ -0,0 +1,20 @@
+
+# The std module.
+
+The std module contains a number of general purpose types and functions for use with a wide variety of app types.
+
+The standard module includes the following namespaces:
+
+* [[std.collections]]  - The Stack, List and Map container classes.
+
+* [[std.filesystem]]  - Functions for working with the OS filesystem.
+
+* [[std.stream]] - The abstract Stream class, along with concrete FileStream and DataStream implementations.
+
+* [[std.memory]] - The DataBuffer class to make dealing with memory buffers easier.
+
+* [[std.graphics]] - Classes for dealing with graphics data such Pixmap and Color.
+
+* [[std.stringio]] - Utility functions to help with loading, saving and parsing strings.
+
+* [[std.random]] - Functions for generating random numbers.