[Slashcode-development] Slash Docs

[Chris N. <pu...@po...>]

OK, I did an overhaul of the POD for Slash and Slash::Utility, and some
minor changes to Slash::Display, Slash::Display::Plugin, and
Slash::Display::Provider.

If you have any questions about the docs or how they should be formatted,
ask.  Here's a recap.  In the =head2 part, put the optional parameters in
the [].  List all the parameters under "Paramaters" (one per =item).
"Return value" is required, all the others should only be there if there is
something to put there (that is, if no Parameters, leave that section out,
same for Side effects and Dependencies).  See the existing POD for examples.


#========================================================================

=head2 foo( [, ])

Describe function here.

=over 4

=item Parameters

=over 4

=item

=back

=item Return value


=item Side effects


=item Dependencies

=back

=cut



-- 
Chris Nandor                      pu...@po...    http://pudge.net/
Open Source Development Network    pu...@os...     http://osdn.com/