Changeset 1046

Show
Ignore:
Timestamp:
01/19/07 23:08:29 (2 years ago)
Author:
gboggs
Message:

Added super simple POD for all methods missing descriptions but one that confuses me...

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • branches/wheeljack/lib/MT/Category.pm

    r1031 r1046  
    482482=head1 DATA LOOKUP 
    483483 
    484 In addition to numeric ID lookup, you can look up or sort records by any 
    485 combination of the following fields. See the I<load> documentation in 
    486 I<MT::Object> for more information. 
     484In addition to numeric ID lookup, you can look up or sort records by 
     485any combination of the following fields. See the L<MT::Object/load> 
     486documentation for more information. 
    487487 
    488488=over 4 
     
    495495 
    496496=head1 NOTES 
    497  
    498 =over 4 
    499  
    500 =item * 
    501497 
    502498When you remove a category using I<MT::Category::remove>, in addition to 
     
    504500(I<MT::Placement> objects) will be removed. 
    505501 
    506 =back 
    507  
    508 =head1 CLASS METHODS 
     502=head1 METHODS 
    509503 
    510504=over 4 
    511505 
    512506=item * MT::Category->top_level_categories($blog_id) 
    513  
    514507 
    515508Returns an array of I<MT::Category> objects representing the top level of 
    516509the category hierarchy in the blog identified by $blog_id. 
    517510 
     511=item * cache(%param) 
     512 
     513Cache the category data given a C<blog_id> (if it has not been 
     514already) and then return the data. 
     515 
     516=item * cache_obj(%param) 
     517 
     518Cache and return the session object. 
     519 
     520=item * category_label_path() 
     521 
     522Compute and return the labeled path of the category. 
     523 
     524=item * category_path() 
     525 
     526Compute and return the path of the category. 
     527 
     528=item * copy_cat($old_cat) 
     529 
     530Set the category column values to those of the old category. 
     531 
     532=item * ping_url_list() 
     533 
     534Return the list of ping URLs for the category. 
     535 
     536=item * remove() 
     537 
     538Remove the cached object and all its children. 
     539 
     540=item * save() 
     541 
     542Save the category! 
     543 
    518544=back 
    519545 
    520 =head1 AUTHOR & COPYRIGHTS 
    521  
    522 Please see the I<MT> manpage for author, copyright, and license information
     546=head1 AUTHOR & COPYRIGHT 
     547 
     548Please see L<MT/AUTHOR & COPYRIGHT>
    523549 
    524550=cut