[Rt-commit] r9658 - in rt/branches/3.6-EXPERIMENTAL-CATEGORIES: lib/RT

[falcone at bestpractical.com]

Author: falcone
Date: Tue Nov 13 18:02:49 2007
New Revision: 9658

Modified:
   rt/branches/3.6-EXPERIMENTAL-CATEGORIES/   (props changed)
   rt/branches/3.6-EXPERIMENTAL-CATEGORIES/lib/RT/CustomFieldValue_Overlay.pm

Log:
 r26549 at ketch:  falcone | 2007-11-13 18:01:24 -0500
 * document some existing methods


Modified: rt/branches/3.6-EXPERIMENTAL-CATEGORIES/lib/RT/CustomFieldValue_Overlay.pm
==============================================================================
--- rt/branches/3.6-EXPERIMENTAL-CATEGORIES/lib/RT/CustomFieldValue_Overlay.pm	(original)
+++ rt/branches/3.6-EXPERIMENTAL-CATEGORIES/lib/RT/CustomFieldValue_Overlay.pm	Tue Nov 13 18:02:49 2007
@@ -80,24 +80,50 @@
     return ($id, $msg);
 }
 
+=head2 Category
+
+Returns the Category assigned to this Value
+Returns udef if there is no Category
+
+=cut
+
 sub Category {
     my $self = shift;
     my $attr = $self->FirstAttribute('Category') or return undef;
     return $attr->Content;
 }
 
+=head2 SetCategory Category
+
+Takes a string Category and stores it as an attribute of this CustomFieldValue
+
+=cut
+
 sub SetCategory {
     my $self = shift;
     my $category = shift;
     $self->SetAttribute(Name => 'Category', Content => $category);
 }
 
+=head2 DeleteCategory
+
+Deletes the category associated with this value
+Returns -1 if there is no Category
+
+=cut
+
 sub DeleteCategory {
     my $self = shift;
     my $attr = $self->FirstAttribute('Category') or return (-1,'No Category Set');
     return $attr->Delete;
 }
 
+=head2 Delete
+
+Make sure we delete our Category when we're deleted
+
+=cut
+
 sub Delete {
     my $self = shift;