documented the subroutines

daxim · Mar 11, 2010 · 967f7db · 967f7db
1 parent 038da04
commit 967f7db
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/Changes b/Changes
@@ -3,6 +3,7 @@ Revision history for Perl extension {{$dist->name}}
 {{$NEXT}}
     - converted the distribution to Dist::Zilla-style
     - moved the code to App::perlzonji; bin/perlzonji is just a thin wrapper
+    - documented the subroutines
 
 0.04  Thu 2010.02.18 20:59:44 CET (Marcel Gruenauer <marcel@cpan.org>)
      - added environment variables (perlrun) and PerlIO layer names

diff --git a/lib/App/perlzonji.pm b/lib/App/perlzonji.pm
@@ -195,3 +195,18 @@ Prints the manual page and exits.
 
 =back
 
+=function run
+
+The main function, which is called by the C<perlzonji> program.
+
+=function try_module
+
+Takes as argument the name of a module, tries to load that module and executes
+the formatter, giving that module as an argument. If loading the module fails,
+this subroutine does nothing.
+
+=function execute
+
+Executes the given command using C<exec()>. In debug mode, it also prints the
+command before executing it.
+