Chris/webperl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation updates.

Browse Source
This commit is contained in:
Chris 2012-12-24 12:06:53 +00:00
parent b8c2cb9ad9
commit 2aa01f58b3
10 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Webperl/AppUser.pm
View File

@ -57,7 +57,7 @@ use constant ADMIN_TYPE => 3; # User type for admin users.
# ============================================================================ # ============================================================================
# Constructor # Constructor
## @cmethod Webperl::AppUser new(%args) ## @cmethod $ new(%args)
# Create a new Webperl::AppUser object. This will create a Webperl::AppUser object that may be # Create a new Webperl::AppUser object. This will create a Webperl::AppUser object that may be
# passed to the Auth class to provide application-specific user handling. # passed to the Auth class to provide application-specific user handling.
# #

2
Webperl/Application.pm
View File

@ -67,7 +67,7 @@ BEGIN {
# ============================================================================ # ============================================================================
# Constructor # Constructor
## @cmethod Webperl::Application new(%args) ## @cmethod $ new(%args)
# Create a new Webperl::Application object. This will create a Webperl::Application # Create a new Webperl::Application object. This will create a Webperl::Application
# object that can be used to generate the pages of a web application. Supported # object that can be used to generate the pages of a web application. Supported
# arguments are: # arguments are:

2
Webperl/Auth.pm
View File

@ -39,7 +39,7 @@ use Webperl::AuthMethods;
# ============================================================================ # ============================================================================
# Constructor # Constructor
## @cmethod Auth new(%args) ## @cmethod $ new(%args)
# Create a new Auth object. This will create an Auth object that may be (for example) # Create a new Auth object. This will create an Auth object that may be (for example)
# passed to SessionHandler to provide user authentication. The arguments to this # passed to SessionHandler to provide user authentication. The arguments to this
# constructor may include: # constructor may include:

2
Webperl/Block.pm
View File

@ -16,7 +16,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class Block ## @class
# The Block class serves as the base class for all plugin block modules in # The Block class serves as the base class for all plugin block modules in
# the system. It provides the basic constructor required to initialise a # the system. It provides the basic constructor required to initialise a
# plugin properly, stub functions for the two key content generation # plugin properly, stub functions for the two key content generation

2
Webperl/Logger.pm
View File

@ -17,7 +17,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class Logger ## @class
# A class to handle logging operations throughout a system. This collects # A class to handle logging operations throughout a system. This collects
# together the various functions needed for displaying log messages and errors # together the various functions needed for displaying log messages and errors
# at various levels of verbosity, in an attempt to cut down on duplicate # at various levels of verbosity, in an attempt to cut down on duplicate

2
Webperl/MediaWiki/Simple.pm
View File

@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class MediaWiki::Simple ## @class
# This module is a simplified wrapper around MediaWiki::API, allowing access to a # This module is a simplified wrapper around MediaWiki::API, allowing access to a
# subset of the MediaWiki API facilities through a simple interface. It should be # subset of the MediaWiki API facilities through a simple interface. It should be
# noted that this *not* intended as a replacement for more comprehensive higher-level # noted that this *not* intended as a replacement for more comprehensive higher-level

3
Webperl/Message.pm
View File

@ -16,10 +16,11 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class Message ## @class
# This is the 'base' class for the Message modules. It provides any functionality # This is the 'base' class for the Message modules. It provides any functionality
# that needs to be shared between the Message::* modules. # that needs to be shared between the Message::* modules.
package Webperl::Message; package Webperl::Message;
use strict; use strict;
use base qw(Webperl::SystemModule); use base qw(Webperl::SystemModule);
use Webperl::Utils qw(hash_or_hashref); use Webperl::Utils qw(hash_or_hashref);

2
Webperl/Message/Queue.pm
View File

@ -19,8 +19,6 @@
## @class ## @class
# This class allows messages to be added to the message queue, or retrieved from # This class allows messages to be added to the message queue, or retrieved from
# it in a format suitable for passing to Message::Sender. # it in a format suitable for passing to Message::Sender.
#
#
package Webperl::Message::Queue; package Webperl::Message::Queue;
use strict; use strict;

2
Webperl/SystemModule.pm
View File

@ -16,7 +16,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class SystemModule ## @class
# This is a base class for system modules, providing common # This is a base class for system modules, providing common
# features - primarily a simple base constructor and error functions. # features - primarily a simple base constructor and error functions.
# Subclasses will generally only need to override the constructor, usually # Subclasses will generally only need to override the constructor, usually

2
Webperl/Template.pm
View File

@ -16,7 +16,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
## @class Template ## @class
# A simple Template class with internationalisation support. Note that # A simple Template class with internationalisation support. Note that
# this class does not cache templates or any fancy stuff like that - it # this class does not cache templates or any fancy stuff like that - it
# just provides a simple interface to generate content based on # just provides a simple interface to generate content based on