Anonymous avatar Anonymous committed b84c899

Enhanced the documentation.

Comments (0)

Files changed (1)

abc-path/Games-ABC_Path-Generator/lib/Games/ABC_Path/Generator.pm

 
 =head1 NAME
 
-Games::ABC_Path::Generator - The great new Games::ABC_Path::Generator!
+Games::ABC_Path::Generator - a generator for ABC Path puzzle games.
 
 =head1 VERSION
 
 
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
-
     use Games::ABC_Path::Generator;
 
-    my $foo = Games::ABC_Path::Generator->new();
-    ...
+    my $gen = Games::ABC_Path::Generator->new({seed => 1});
 
-=head1 EXPORT
-
-A list of functions that can be exported.  You can delete this section
-if you don't export anything, such as for a purely object-oriented module.
+    # Returns a Games::ABC_Path::Generator::Riddle object.
+    my $riddle = $gen->calc_riddle();
 
 =head1 SUBROUTINES/METHODS
 
+=head2 my $gen = Games::ABC_Path::Generator->new({seed => $seed}); 
+
+Initialised a new generator with the random number generator seed $seed .
+
 =cut
 
 sub _init
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.