Code documentation (FIXME)

The system used to document methods and classes within eBox's code is http://www.naturaldocs.org

Some hints

Documenting parameters

Most of the documented subs across eBox are using positional parameters. Each parameter is "named" just for the sake of clarification.

To document if parameters are named or positional in naturaldocs. Write a blank line and a bulletin followed by optional or named after the listed parameters.

To express if a parmeter is optional, add to the parameter description *(Optional)*

As a rule of thumb, and following the idea depicted in Perl Best Practices we should:

• use positional parameters if their number is <= 3
• use named parameters if > 3