Documentation updates.

This commit is contained in:
Chris 2012-03-26 15:00:35 +01:00
parent 3c4397714f
commit a675c0f528

View File

@ -18,22 +18,23 @@
## @class
# Provide the core functionality required to initialise and run a web application
# based on the webperl framework. This class allows a web application to be
# created with minimal code in the index.cgi script - all the developer needs to
# do is:
#<pre>
# use lib "/path/to/webperl";
# use lib "modules";
# use Application;
# use AppUser::MySystem; # Implemented in modules/AppUser/MySystem.pm
# based on the webperl framework. This class is effectively a bootdtrapper,
# allowing the core of a web application to be created with minimal code - all
# the developer needs to do is:
#
# use lib "/path/to/webperl";
# use lib "modules";
# use Application;
# use AppUser::MySystem; # Implemented in modules/AppUser/MySystem.pm
#
# my $app = Application -> new(appuser => AppUser::MySystem -> new());
# $app -> run();
#
# my $app = Application -> new(appuser => AppUser::MySystem -> new());
# $app -> run();
#</pre>
# In general, you will also want to load CGI::Carp and set it up, to handle
# problems with fatals. Note that using this module is not required to use
# the webperl modules - you can load the modules individually and set them
# up as needed, this just simplifies the process.
# up as needed, this just simplifies the process. See the @ref overview Overview
# documentation for more details about the operation of this class.
#
# @todo Web applications created using the Application class use the default
# language and template settings - i18n and template selection need to