Page Contents
Documenting the internals of Aranha
Use some documentation system like Doxygen
Documenting the interface exposed to C modules
Probably doxygen again, almost certainly confined to the interfacing header files
Documenting the interface exposed to the Lua side of things
Some new form of documentation. Shall we call it AranhaDoc?
This would also be used for documenting Lua modules etc, so should be a comment-based syntax with the facility to work from C or Lua sources to generate equivalent information.
Desired features
- Capable of documenting functions callable from the Lua side from both C and Lua sources
- Capable of indicating function and object syntaxes, ideally linked to Aranha/ClassesAndObjects syntax.
- Intermediate format should be Lua code. To facilitate introspection it should be possible for modules etc to provide a FooModule.doc file alongside their FooModule.am and FooModule.so
- There should be multiple output formats including hyperlinked HTML (Ideally dynamically generatable) and postscript or PDF or LaTeX or something which is nice to print (HTML would do with a good stylesheet)
- Prototyping it at http://aranha.pepperfish.net/docs/
Possible useful things
- ltokens -- lhf -- not pure lua, may not preserve comments
- lparser -- rici -- pure lua, preserves comments -- needs modifying to fit with .LanguageModifications
