QA » openQA Project » openQA Tests

Each function in the lib/ folder needs to be documented with POD

AC¶

• AC1: Most of the functions are documented
• AC2: Undocumented functions are marked as undocumented
• AC3: each function in lib/ has a POD block that explains it

How to write the documentation¶

• At level one we have the name of the module and a short synopsis with brief description
• At level two we have the names of each functions before the functions

=head1 MY_MODULE

=head1 SYNOPSIS

    use lib::my_module

This is a module that does foobar

=cut

use testapi
use stuff
use other_stuff

=head2 my_function

 my_function($arg1, $arg2); 

a single space before it is required!

format for list item:

=over

=item * list 1

=item * list 2

=back

This is a function that does nothing because it's for documentation purposes

Describe here also, what C<$arg1> and C<$arg2> will do and also cover what the function returns if applicable.

=cut
sub my_function {}