Introduction
These are some of the notes I took while looking at addon source... Please look at Io: Getting started for more documentation on Io.
Addon files
- depends
- A single line containing all the dependencies of the addon. The addon names are space sperated.
- protos
- A single line containing a list of Protos created by the addon.
- io/
- The directory with all the Io code needed for the addon.
- samples/
- Any sample programs. These should are not ment to be distributed for general use, and should be considered part of the documentation.
- source/
- The C source.
- docs/
- The IoDoc generated documentation goes here. You can also add any other documentation here.
- build.io
- The build file for the Io build system. This file will create a clone of the AddonBuilder and set all the dependencies and platform specific information.
Adding documentation to your C code
Documentation for the functions implemented in your C code is done using the Io docString convention. Place the default Io documentation string in a multi-line comment within your Io code. Start the comment with #io.
Here is an example from the OpenGL
/*#io
GLScissor ioDoc(
docCopyright("Steve Dekorte", 2002)
docLicense("BSD revised")
docCategory("Graphics")
*/
Some of the catagories already in addons are:
- Compression
- Databases
- DataStructures
- Digests
- Encryption
- Filesystem
- Graphics
- Math
- Media
- Networking
- Other
- RegularExpressions
- Server
- XML
See also
Io: Getting started.
|