From 2aa01f58b369017b82089252a64660be68f3c5b1 Mon Sep 17 00:00:00 2001 From: Chris Date: Mon, 24 Dec 2012 12:06:53 +0000 Subject: [PATCH] Documentation updates. --- Webperl/AppUser.pm | 2 +- Webperl/Application.pm | 2 +- Webperl/Auth.pm | 2 +- Webperl/Block.pm | 2 +- Webperl/Logger.pm | 2 +- Webperl/MediaWiki/Simple.pm | 2 +- Webperl/Message.pm | 3 ++- Webperl/Message/Queue.pm | 2 -- Webperl/SystemModule.pm | 2 +- Webperl/Template.pm | 2 +- 10 files changed, 10 insertions(+), 11 deletions(-) diff --git a/Webperl/AppUser.pm b/Webperl/AppUser.pm index 4518dca..41395cd 100644 --- a/Webperl/AppUser.pm +++ b/Webperl/AppUser.pm @@ -57,7 +57,7 @@ use constant ADMIN_TYPE => 3; # User type for admin users. # ============================================================================ # 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 # passed to the Auth class to provide application-specific user handling. # diff --git a/Webperl/Application.pm b/Webperl/Application.pm index 83ce42b..6083a87 100644 --- a/Webperl/Application.pm +++ b/Webperl/Application.pm @@ -67,7 +67,7 @@ BEGIN { # ============================================================================ # Constructor -## @cmethod Webperl::Application new(%args) +## @cmethod $ new(%args) # 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 # arguments are: diff --git a/Webperl/Auth.pm b/Webperl/Auth.pm index 7057f53..dde0afd 100644 --- a/Webperl/Auth.pm +++ b/Webperl/Auth.pm @@ -39,7 +39,7 @@ use Webperl::AuthMethods; # ============================================================================ # Constructor -## @cmethod Auth new(%args) +## @cmethod $ new(%args) # 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 # constructor may include: diff --git a/Webperl/Block.pm b/Webperl/Block.pm index 4e3fffb..80b65cd 100644 --- a/Webperl/Block.pm +++ b/Webperl/Block.pm @@ -16,7 +16,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -## @class Block +## @class # 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 # plugin properly, stub functions for the two key content generation diff --git a/Webperl/Logger.pm b/Webperl/Logger.pm index 18cafc0..73f9ea2 100644 --- a/Webperl/Logger.pm +++ b/Webperl/Logger.pm @@ -17,7 +17,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -## @class Logger +## @class # A class to handle logging operations throughout a system. This collects # together the various functions needed for displaying log messages and errors # at various levels of verbosity, in an attempt to cut down on duplicate diff --git a/Webperl/MediaWiki/Simple.pm b/Webperl/MediaWiki/Simple.pm index 9b51384..09661a2 100644 --- a/Webperl/MediaWiki/Simple.pm +++ b/Webperl/MediaWiki/Simple.pm @@ -15,7 +15,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -## @class MediaWiki::Simple +## @class # 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 # noted that this *not* intended as a replacement for more comprehensive higher-level diff --git a/Webperl/Message.pm b/Webperl/Message.pm index b58b351..647a8e9 100644 --- a/Webperl/Message.pm +++ b/Webperl/Message.pm @@ -16,10 +16,11 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -## @class Message +## @class # This is the 'base' class for the Message modules. It provides any functionality # that needs to be shared between the Message::* modules. package Webperl::Message; + use strict; use base qw(Webperl::SystemModule); use Webperl::Utils qw(hash_or_hashref); diff --git a/Webperl/Message/Queue.pm b/Webperl/Message/Queue.pm index 2e9d9c0..b5ccb1f 100644 --- a/Webperl/Message/Queue.pm +++ b/Webperl/Message/Queue.pm @@ -19,8 +19,6 @@ ## @class # This class allows messages to be added to the message queue, or retrieved from # it in a format suitable for passing to Message::Sender. -# -# package Webperl::Message::Queue; use strict; diff --git a/Webperl/SystemModule.pm b/Webperl/SystemModule.pm index 5a146bd..798e319 100644 --- a/Webperl/SystemModule.pm +++ b/Webperl/SystemModule.pm @@ -16,7 +16,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -## @class SystemModule +## @class # This is a base class for system modules, providing common # features - primarily a simple base constructor and error functions. # Subclasses will generally only need to override the constructor, usually diff --git a/Webperl/Template.pm b/Webperl/Template.pm index d2e8aee..cc57592 100644 --- a/Webperl/Template.pm +++ b/Webperl/Template.pm @@ -16,7 +16,7 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -## @class Template +## @class # A simple Template class with internationalisation support. Note that # this class does not cache templates or any fancy stuff like that - it # just provides a simple interface to generate content based on