Changeset 1646

Show
Ignore:
Timestamp:
09/02/06 06:54:31
Author:
mark
Message:

r11@travis: mark | 2006-09-01 19:58:28 +0100
improved the documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/plagger/lib/Plagger/Plugin/Notify/Eject.pm

    r218 r1646  
    5151=head1 DESCRIPTION 
    5252 
     53This class ejects the CD each time a notification is triggered. 
     54 
     55This class relies on helper classes for the functionality for the  
     56particular operating system you are working on.  Provided in the 
     57main Plagger distribution are helper classes for Linux, FreeBSD, 
     58Microsoft Windows (MSWin32) and Mac OS X (Darwin.) 
     59 
     60=head2 Writing helper classes 
     61 
     62This module relies on a helper class existing that is named after 
     63the architecture name returned in C<$^O>. 
     64 
     65Each module must simply subclass this module and implement the 
     66C<eject> method.  For example, for the hypothetical HAL2000 system:  
     67 
     68  package Plagger::Plugin::Notify::Eject::hal2000; 
     69  use base qw( Plagger::Plugin::Notify::Eject ); 
     70 
     71  sub eject { 
     72     system("eject_the_cd_bay_doors_hal"); 
     73  } 
     74   
     75  1; 
    5376 
    5477=head1 AUTHOR