diff --git a/doc/site/modules/index.markdown b/doc/site/modules/index.markdown index dff56ecc..a84ab5be 100644 --- a/doc/site/modules/index.markdown +++ b/doc/site/modules/index.markdown @@ -44,6 +44,6 @@ applications that want to embed Wren. [libuv]: http://libuv.org * [io](io) -* [process](process) +* [os](os) * [scheduler](scheduler) * [timer](timer) diff --git a/doc/site/modules/os/index.markdown b/doc/site/modules/os/index.markdown new file mode 100644 index 00000000..0ddc56ca --- /dev/null +++ b/doc/site/modules/os/index.markdown @@ -0,0 +1,7 @@ +^title Module "os" + +The os module exposes classes for accessing capabilities provided by the +underlying operating system. + +* [Platform](platform.html) +* [Process](process.html) diff --git a/doc/site/modules/os/platform.markdown b/doc/site/modules/os/platform.markdown new file mode 100644 index 00000000..f4b62b5e --- /dev/null +++ b/doc/site/modules/os/platform.markdown @@ -0,0 +1,26 @@ +^title Platform Class + +The Platform class exposes basic information about the operating system Wren is +running on top of. + +## Static Methods + +### **name** + +The name of the platform. This roughly describes the operating system, and is +usually one of: + +* "iOS" +* "Linux" +* "OS X" +* "POSIX" +* "Unix" +* "Windows" + +If Wren was compiled for an unknown operating system, returns "Unknown". + +### **isPosix** + +Returns `true` if the host operating system is known to support the POSIX +standard. This is true for Linux and other Unices, as well as the various Apple +operating systems. diff --git a/doc/site/modules/process/process.markdown b/doc/site/modules/os/process.markdown similarity index 90% rename from doc/site/modules/process/process.markdown rename to doc/site/modules/os/process.markdown index ff3787ea..8589572b 100644 --- a/doc/site/modules/process/process.markdown +++ b/doc/site/modules/os/process.markdown @@ -1,6 +1,6 @@ ^title Process Class -The Process class lets you work with operating processes, including the +The Process class lets you work with operating system processes, including the currently running one. ## Static Methods diff --git a/doc/site/modules/process/template.html b/doc/site/modules/os/template.html similarity index 87% rename from doc/site/modules/process/template.html rename to doc/site/modules/os/template.html index 5d26689b..b8a2f191 100644 --- a/doc/site/modules/process/template.html +++ b/doc/site/modules/os/template.html @@ -22,11 +22,12 @@