digital-scurf wiki — Aranha > Specs > Code Documentation

Introduction

Documenting the API of Aranha is a necessary part of providing users with what they need in order to develop applications using Aranha.

Documentation format

The format of code documentation is as follows:

-=-
Title
<BLANKLINE>
Description
@param name(typelist) Description
@return (typelist) Description
-=-

In the description there can be sections marked out with {@verb} and {@endverb} lines. These provide a verbatim (code or ascii art) environment. The leading spaces will be stripped out and a warning will be issued if the number of spaces leading the {@verb} and {@endverb} dont' match.

Anywhere, a word starting with a backslach is considered a cross-reference. These are of the form {\[major][:method]}. If the major is absent then it defaults to the current aggregate (class or interface). If the method is absent then the major is resolved in the order: function params, then any class or interface name, then any global name (dotted is permitted), and then any module name.

Whitespace is nearly always collapsed except inside verbatim sections.

Tasks