Difference between revisions of "Guide:Libraries"

From IokeWiki
Jump to: navigation, search
(ISpec)
(DokGen)
 
Line 19: Line 19:
 
{{main|DokGen}}
 
{{main|DokGen}}
  
DokGen is the tool that is used to generate the reference documentation for Ioke. The goal is that it will be a general purpose tool for any Ioke application. It extracts the documentation information from defined objects and then generates an HTML structure from it that can be easily navigated. If specs are available for objects and methods, it will try to incorporate these together with the documentation. At the moment, there is no way to run dokgen on a subset of Ioke code, but that should be available very soon now. At the moment, running the dokgen script will create a directory called "dok" which contains the full documentation. It will use all specs it can find in the directory test.
+
DokGen is the tool that is used to generate the reference documentation for Ioke, and it generates output similar to [http://rdoc.sourceforge.net/ RDoc]. Its goal is to be a general purpose tool for any Ioke application.

Latest revision as of 02:41, 26 January 2009

Libraries

Ioke ships with several small libraries that are useful for different tasks. The main ones are IIk, ISpec and DokGen, and these will be documented a bit more in this chapter. All of them are considered a core part of Ioke since the functionality they provide is tied to the distribution.

IIk

Main article: Iik

IIk is the interactive Ioke prompt, which will run if you give no arguments to the ioke script. At the IIk prompt you can execute mostly all the same kind of code that could execute inside of an Ioke script file. The main difference is that this code will not be assigned to Ground, but instead will run in another context that is specific for the purposes of IIk.

ISpec

Main article: ISpec

ISpec is a minimal port of the Ruby RSpec framework for behavior-driven development. It supports the bare minimum to allow testing of Ioke itself. The current Ioke test suite is completely written in ISpec, and it seems to be a capable environment.

DokGen

Main article: DokGen

DokGen is the tool that is used to generate the reference documentation for Ioke, and it generates output similar to RDoc. Its goal is to be a general purpose tool for any Ioke application.