POD

POD stands for Plain Old Documentation format, and we're trying to standardize on all DW code being documented in this fashion.

There is basic documentation about the format.

Examples of code files documented this way already:

cgi-bin/DW/InviteCodes.pm
cgi-bin/DW/Shop/Item/Rename.pm

Examples

Function with named and optional arguments

=head2 C<< $class->check_code( code => $invite [, userid => $recipient] ) >>
 
Checks whether code $invite is valid before trying to create an account. Takes
an optional $recipient userid, to protect the code from accidentally being used
if the form is double-submitted.
 
=cut