[Rt-commit] r3585 - in rt/branches/3.4-RELEASE: . lib/RT
lib/RT/Interface
kevinr at bestpractical.com
kevinr at bestpractical.com
Tue Aug 2 20:18:57 EDT 2005
Author: kevinr
Date: Tue Aug 2 20:18:54 2005
New Revision: 3585
Modified:
rt/branches/3.4-RELEASE/ (props changed)
rt/branches/3.4-RELEASE/lib/RT/Base.pm
rt/branches/3.4-RELEASE/lib/RT/CachedGroupMember_Overlay.pm
rt/branches/3.4-RELEASE/lib/RT/CustomFields_Overlay.pm
rt/branches/3.4-RELEASE/lib/RT/EmailParser.pm
rt/branches/3.4-RELEASE/lib/RT/Group_Overlay.pm
rt/branches/3.4-RELEASE/lib/RT/Groups_Overlay.pm
rt/branches/3.4-RELEASE/lib/RT/Handle.pm
rt/branches/3.4-RELEASE/lib/RT/Interface/Email.pm
rt/branches/3.4-RELEASE/lib/RT/Queue_Overlay.pm
rt/branches/3.4-RELEASE/lib/RT/SearchBuilder.pm
rt/branches/3.4-RELEASE/lib/RT/Template_Overlay.pm
Log:
r6849 at SAD-GIRL-IN-SNOW: kevinr | 2005-08-02 20:17:38 -0400
* POD formatting fixes
Modified: rt/branches/3.4-RELEASE/lib/RT/Base.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Base.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Base.pm Tue Aug 2 20:18:54 2005
@@ -52,9 +52,18 @@
@EXPORT=qw(loc CurrentUser);
-=head1 FUNCTIONS
+=head1 NAME
+
+RT::Base
+
+
+=head1 SYNOPSIS
+=head1 DESCRIPTION
+=head1 FUNCTIONS
+
+=cut
# {{{ sub CurrentUser
@@ -100,7 +109,7 @@
}
-=item loc LOC_STRING
+=head2 loc LOC_STRING
l is a method which takes a loc string
to this object's CurrentUser->LanguageHandle for localization.
Modified: rt/branches/3.4-RELEASE/lib/RT/CachedGroupMember_Overlay.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/CachedGroupMember_Overlay.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/CachedGroupMember_Overlay.pm Tue Aug 2 20:18:54 2005
@@ -48,25 +48,39 @@
use strict;
no warnings qw(redefine);
-# {{{ Create
+=head1 NAME
-=item Create PARAMHASH
+ RT::CachedGroupMember
+
+=head1 SYNOPSIS
+
+ use RT::CachedGroupMember;
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=cut
+
+# {{ Create
+
+=head2 Create PARAMHASH
Create takes a hash of values and creates a row in the database:
- 'Group' is the "top level" group we're building the cache for. This is an
- RT::Principal object
+ 'Group' is the "top level" group we're building the cache for. This
+ is an RT::Principal object
- 'Member' is the RT::Principal of the user or group we're adding
- to the cache.
+ 'Member' is the RT::Principal of the user or group we're adding to
+ the cache.
- 'ImmediateParent' is the RT::Principal of the group that this principal
- belongs to to get here
+ 'ImmediateParent' is the RT::Principal of the group that this
+ principal belongs to to get here
int(11) 'Via' is an internal reference to CachedGroupMembers->Id of
- the "parent" record of this cached group member. It should be empty if this
- member is a "direct" member of this group. (In that case, it will be set to this
- cached group member's id after creation)
+ the "parent" record of this cached group member. It should be empty if
+ this member is a "direct" member of this group. (In that case, it will
+ be set to this cached group member's id after creation)
This routine should _only_ be called by GroupMember->Create
Modified: rt/branches/3.4-RELEASE/lib/RT/CustomFields_Overlay.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/CustomFields_Overlay.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/CustomFields_Overlay.pm Tue Aug 2 20:18:54 2005
@@ -89,7 +89,7 @@
# {{{ sub LimitToGlobalOrQueue
-=item LimitToGlobalOrQueue QUEUEID
+=head2 LimitToGlobalOrQueue QUEUEID
Limits the set of custom fields found to global custom fields or those tied to the queue with ID QUEUEID
@@ -154,9 +154,9 @@
=head2 _DoSearch
- A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that _Disabled ro
-ws never get seen unless
-we're explicitly trying to see them.
+A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that
+ _Disabled rows never get seen unless we're explicitly trying to see
+them.
=cut
Modified: rt/branches/3.4-RELEASE/lib/RT/EmailParser.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/EmailParser.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/EmailParser.pm Tue Aug 2 20:18:54 2005
@@ -77,6 +77,7 @@
=head2 new
+Returns a new RT::EmailParser object
=cut
@@ -412,7 +413,7 @@
# {{{ IsRTAddress
-=item IsRTaddress ADDRESS
+=head2 IsRTaddress ADDRESS
Takes a single parameter, an email address.
Returns true if that address matches the $RTAddressRegexp.
@@ -446,7 +447,7 @@
# {{{ CullRTAddresses
-=item CullRTAddresses ARRAY
+=head2 CullRTAddresses ARRAY
Takes a single argument, an array of email addresses.
Returns the same array with any IsRTAddress()es weeded out.
@@ -491,7 +492,7 @@
# template for the rejection message.
-=item LookupExternalUserInfo
+=head2 LookupExternalUserInfo
LookupExternalUserInfo is a site-definable method for synchronizing
incoming users with an external data source.
@@ -504,12 +505,12 @@
It returns (FoundInExternalDatabase, ParamHash);
- FoundInExternalDatabase must be set to 1 before return if the user was
- found in the external database.
+ FoundInExternalDatabase must be set to 1 before return if the user
+ was found in the external database.
- ParamHash is a Perl parameter hash which can contain at least the following
- fields. These fields are used to populate RT's users database when the user
- is created
+ ParamHash is a Perl parameter hash which can contain at least the
+ following fields. These fields are used to populate RT's users
+ database when the user is created.
EmailAddress is the email address that RT should use for this user.
Name is the 'Name' attribute RT should use for this user.
Modified: rt/branches/3.4-RELEASE/lib/RT/Group_Overlay.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Group_Overlay.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Group_Overlay.pm Tue Aug 2 20:18:54 2005
@@ -52,21 +52,13 @@
=head1 SYNOPSIS
- use RT::Group;
+use RT::Group;
my $group = new RT::Group($CurrentUser);
=head1 DESCRIPTION
An RT group object.
-=head1 AUTHOR
-
-Jesse Vincent, jesse at bestpractical.com
-
-=head1 SEE ALSO
-
-RT
-
=head1 METHODS
@@ -1179,7 +1171,7 @@
# {{{ sub _CleanupInvalidDelegations
-=head2 sub _CleanupInvalidDelegations { InsideTransaction => undef }
+=head2 _CleanupInvalidDelegations { InsideTransaction => undef }
Revokes all ACE entries delegated by members of this group which are
inconsistent with their current delegation rights. Does not perform
@@ -1289,7 +1281,7 @@
-=item CurrentUserHasRight RIGHTNAME
+=head2 CurrentUserHasRight RIGHTNAME
Returns true if the current user has the specified right for this group.
@@ -1379,3 +1371,11 @@
1;
+=head1 AUTHOR
+
+Jesse Vincent, jesse at bestpractical.com
+
+=head1 SEE ALSO
+
+RT
+
Modified: rt/branches/3.4-RELEASE/lib/RT/Groups_Overlay.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Groups_Overlay.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Groups_Overlay.pm Tue Aug 2 20:18:54 2005
@@ -157,7 +157,7 @@
# {{{ LimitToRolesForQueue
-=item LimitToRolesForQueue QUEUE_ID
+=head2 LimitToRolesForQueue QUEUE_ID
Limits the set of groups found to role groups for queue QUEUE_ID
@@ -174,7 +174,7 @@
# {{{ LimitToRolesForTicket
-=item LimitToRolesForTicket Ticket_ID
+=head2 LimitToRolesForTicket Ticket_ID
Limits the set of groups found to role groups for Ticket Ticket_ID
@@ -191,7 +191,7 @@
# {{{ LimitToRolesForSystem
-=item LimitToRolesForSystem System_ID
+=head2 LimitToRolesForSystem System_ID
Limits the set of groups found to role groups for System System_ID
Modified: rt/branches/3.4-RELEASE/lib/RT/Handle.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Handle.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Handle.pm Tue Aug 2 20:18:54 2005
@@ -104,7 +104,7 @@
}
-=item BuildDSN
+=head2 BuildDSN
Build the DSN for the RT database. doesn't take any parameters, draws all that
from the config file.
Modified: rt/branches/3.4-RELEASE/lib/RT/Interface/Email.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Interface/Email.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Interface/Email.pm Tue Aug 2 20:18:54 2005
@@ -173,7 +173,7 @@
# {{{ IsRTAddress
-=item IsRTAddress ADDRESS
+=head2 IsRTAddress ADDRESS
Takes a single parameter, an email address.
Returns true if that address matches the $RTAddressRegexp.
@@ -198,7 +198,7 @@
# {{{ CullRTAddresses
-=item CullRTAddresses ARRAY
+=head2 CullRTAddresses ARRAY
Takes a single argument, an array of email addresses.
Returns the same array with any IsRTAddress()es weeded out.
@@ -476,11 +476,12 @@
status code is a numeric value.
- for temporary failures, status code should be -75
+ for temporary failures, the status code should be -75
- for permanent failures which are handled by RT, status code should be 0
+ for permanent failures which are handled by RT, the status code
+ should be 0
- for succces, the status code should be 1
+ for succces, the status code should be 1
Modified: rt/branches/3.4-RELEASE/lib/RT/Queue_Overlay.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Queue_Overlay.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Queue_Overlay.pm Tue Aug 2 20:18:54 2005
@@ -232,14 +232,16 @@
=head2 IsValidStatus VALUE
-Returns true if VALUE is a valid status. Otherwise, returns 0
+Returns true if VALUE is a valid status. Otherwise, returns 0.
-=for testing
+=begin testing
my $q = RT::Queue->new($RT::SystemUser);
ok($q->IsValidStatus('new')== 1, 'New is a valid status');
ok($q->IsValidStatus('f00')== 0, 'f00 is not a valid status');
+=end testing
+
=cut
sub IsValidStatus {
@@ -259,13 +261,15 @@
Returns true if VALUE is a Active status. Otherwise, returns 0
-=for testing
+=begin testing
my $q = RT::Queue->new($RT::SystemUser);
ok($q->IsActiveStatus('new')== 1, 'New is a Active status');
ok($q->IsActiveStatus('rejected')== 0, 'Rejected is an inactive status');
ok($q->IsActiveStatus('f00')== 0, 'f00 is not a Active status');
+=end testing
+
=cut
sub IsActiveStatus {
@@ -285,13 +289,15 @@
Returns true if VALUE is a Inactive status. Otherwise, returns 0
-=for testing
+=begin testing
my $q = RT::Queue->new($RT::SystemUser);
ok($q->IsInactiveStatus('new')== 0, 'New is a Active status');
ok($q->IsInactiveStatus('rejected')== 1, 'rejeected is an Inactive status');
ok($q->IsInactiveStatus('f00')== 0, 'f00 is not a Active status');
+=end testing
+
=cut
sub IsInactiveStatus {
@@ -334,10 +340,8 @@
($id, $val) = $queue->Create( Name => '66');
ok(!$id, $val);
-
=end testing
-
=cut
sub Create {
@@ -399,7 +403,7 @@
Takes a boolean.
1 will cause this queue to no longer be avaialble for tickets.
-0 will re-enable this queue
+0 will re-enable this queue.
=cut
@@ -490,7 +494,7 @@
# {{{ CustomField
-=item CustomField NAME
+=head2 CustomField NAME
Load the queue-specific custom field named NAME
@@ -507,7 +511,7 @@
# {{{ CustomFields
-=item CustomFields
+=head2 CustomFields
Returns an RT::CustomFields object containing all global custom fields, as well as those tied to this queue
@@ -997,8 +1001,8 @@
=head2 IsCc PRINCIPAL_ID
- Takes an RT::Principal id.
- Returns true if the principal is a requestor of the current queue.
+Takes an RT::Principal id.
+Returns true if the principal is a requestor of the current queue.
=cut
@@ -1017,8 +1021,8 @@
=head2 IsAdminCc PRINCIPAL_ID
- Takes an RT::Principal id.
- Returns true if the principal is a requestor of the current queue.
+Takes an RT::Principal id.
+Returns true if the principal is a requestor of the current queue.
=cut
Modified: rt/branches/3.4-RELEASE/lib/RT/SearchBuilder.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/SearchBuilder.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/SearchBuilder.pm Tue Aug 2 20:18:54 2005
@@ -311,7 +311,7 @@
# {{{ sub ItemsOrderBy
-=item ItemsOrderBy
+=head2 ItemsOrderBy
If it has a SortOrder attribute, sort the array by SortOrder.
Otherwise, if it has a "Name" attribute, sort alphabetically by Name
@@ -338,7 +338,7 @@
# {{{ sub ItemsArrayRef
-=item ItemsArrayRef
+=head2 ItemsArrayRef
Return this object's ItemsArray, in the order that ItemsOrderBy sorts
it.
Modified: rt/branches/3.4-RELEASE/lib/RT/Template_Overlay.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/Template_Overlay.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/Template_Overlay.pm Tue Aug 2 20:18:54 2005
@@ -324,7 +324,7 @@
# {{{ sub Parse
-=item Parse
+=head2 Parse
This routine performs Text::Template parsing on the template and then
imports the results into a MIME::Entity so we can really use it
More information about the Rt-commit
mailing list