From 7d168c9fb96de826c7164cb101557b9106ac6f1c Mon Sep 17 00:00:00 2001 From: jq Date: Tue, 29 May 2007 12:03:32 +0000 Subject: [PATCH] [project @ 6343] r5240@merlin: jquelin | 2007-05-29 13:19:47 +0200 fixed pod to use audio::mpd::common --- lib/Audio/MPD/Common/Item.pm | 27 +++++++++++++--------- lib/Audio/MPD/Common/Item/Directory.pm | 16 ++++++++----- lib/Audio/MPD/Common/Item/Playlist.pm | 21 +++++++++++++---- lib/Audio/MPD/Common/Item/Song.pm | 16 ++++++++----- lib/Audio/MPD/Common/Stats.pm | 36 +++++++++++++++-------------- lib/Audio/MPD/Common/Status.pm | 42 +++++++++++++++++----------------- lib/Audio/MPD/Common/Time.pm | 41 +++++++++++++++++---------------- 7 files changed, 113 insertions(+), 86 deletions(-) diff --git a/lib/Audio/MPD/Common/Item.pm b/lib/Audio/MPD/Common/Item.pm index 986dfb3..f5f7142 100644 --- a/lib/Audio/MPD/Common/Item.pm +++ b/lib/Audio/MPD/Common/Item.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -39,21 +39,22 @@ __END__ =head1 NAME -POE::Component::Client::MPD::Item - a generic collection item +Audio::MPD::Common::Item - a generic collection item =head1 SYNOPSIS - my $item = POE::Component::Client::MPD::Item->new( %params ); + my $item = Audio::MPD::Common::Item->new( %params ); =head1 DESCRIPTION -C is a virtual class representing a generic -item of mpd's collection. It can be either a song or a directory. Depending on -the params given to C, it will create and return an -C or an -C object. Currently, the +C is a virtual class representing a generic +item of mpd's collection. It can be either a song, a directory or a playlist. + +Depending on the params given to C, it will create and return an +C, an C +or an C object. Currently, the discrimination is done on the existence of the C key of C<%params>. @@ -73,9 +74,13 @@ C object. =head1 SEE ALSO -For all related information (bug reporting, mailing-list, pointers to -MPD and POE, etc.), refer to C's pod, -section C +=over 4 + +=item L + +=item L + +=back =head1 AUTHOR diff --git a/lib/Audio/MPD/Common/Item/Directory.pm b/lib/Audio/MPD/Common/Item/Directory.pm index f626f5a..5da4a7a 100644 --- a/lib/Audio/MPD/Common/Item/Directory.pm +++ b/lib/Audio/MPD/Common/Item/Directory.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -23,7 +23,7 @@ __END__ =head1 NAME -POE::Component::Client::MPD::Item::Directory - a directory object +Audio::MPD::Common::Item::Directory - a directory object =head1 SYNOPSIS @@ -33,7 +33,7 @@ POE::Component::Client::MPD::Item::Directory - a directory object =head1 DESCRIPTION -C is more a placeholder for a +C is more a placeholder for a hash ref with one pre-defined key, namely the directory name. @@ -47,9 +47,13 @@ The only other public method is an accessor: directory(). =head1 SEE ALSO -For all related information (bug reporting, mailing-list, pointers to -MPD and POE, etc.), refer to C's pod, -section C +=over 4 + +=item L + +=item L + +=back =head1 AUTHOR diff --git a/lib/Audio/MPD/Common/Item/Playlist.pm b/lib/Audio/MPD/Common/Item/Playlist.pm index 747f510..8f3b10d 100644 --- a/lib/Audio/MPD/Common/Item/Playlist.pm +++ b/lib/Audio/MPD/Common/Item/Playlist.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -23,7 +23,7 @@ __END__ =head1 NAME -POE::Component::Client::MPD::Item::Playlist - a playlist object +Audio::MPD::Common::Item::Playlist - a playlist object =head1 SYNOPSIS @@ -33,18 +33,29 @@ POE::Component::Client::MPD::Item::Playlist - a playlist object =head1 DESCRIPTION -C is more a placeholder for a hash ref with one -pre-defined key, namely the playlist name. +C is more a placeholder for a hash ref +with one pre-defined key, namely the playlist name. =head1 PUBLIC METHODS This module only has a C constructor, which should only be called by -C's constructor. +C's constructor. The only other public method is an accessor: playlist(). +=head1 SEE ALSO + +=over 4 + +=item L + +=item L + +=back + + =head1 AUTHOR Jerome Quelin, C<< >> diff --git a/lib/Audio/MPD/Common/Item/Song.pm b/lib/Audio/MPD/Common/Item/Song.pm index 03c229c..c4dfd9e 100644 --- a/lib/Audio/MPD/Common/Item/Song.pm +++ b/lib/Audio/MPD/Common/Item/Song.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -54,12 +54,12 @@ __END__ =head1 NAME -POE::Component::Client::MPD::Item::Song - a song object with some audio tags +Audio::MPD::Common::Item::Song - a song object with some audio tags =head1 DESCRIPTION -C is more a placeholder for a +C is more a placeholder for a hash ref with some pre-defined keys, namely some audio tags. @@ -102,9 +102,13 @@ possibility always exist of course, since it's a path. =head1 SEE ALSO -For all related information (bug reporting, mailing-list, pointers to -MPD and POE, etc.), refer to C's pod, -section C +=over 4 + +=item L + +=item L + +=back =head1 AUTHOR diff --git a/lib/Audio/MPD/Common/Stats.pm b/lib/Audio/MPD/Common/Stats.pm index 442302c..1218dd1 100644 --- a/lib/Audio/MPD/Common/Stats.pm +++ b/lib/Audio/MPD/Common/Stats.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -26,7 +26,7 @@ __END__ =head1 NAME -POE::Component::Client::MPD::Stats - class representing MPD stats +Audio::MPD::Common::Stats - class representing MPD stats =head1 SYNOPSIS @@ -37,12 +37,11 @@ POE::Component::Client::MPD::Stats - class representing MPD stats =head1 DESCRIPTION The MPD server maintains some general information. Those information can be -queried with the C event of C. This method fires back an -event with a C, which C is an C object, -containing all relevant information. +queried with the mpd modules. Some of those information are served to you as +an C object. -Note that an C object does B update itself regularly, -and thus should be used immediately. +Note that an C object does B update itself +regularly, and thus should be used immediately. =head1 METHODS @@ -53,12 +52,11 @@ and thus should be used immediately. =item new( %kv ) -The C method is the constructor for the C class. -It is called internally by C, with the result of the -C command sent to MPD server. +The C method is the constructor for the C +class. -Note: one should B ever instantiate an C object -directly - use the C event of C. +Note: one should B ever instantiate an C +object directly - use the mpd modules instead. =back @@ -108,15 +106,19 @@ Last database update in UNIX time. Please note that those accessors are read-only: changing a value will B -change the current settings of MPD server. Use C events to alter -the settings. +change the current settings of MPD server. Use the mpd modules to alter the +settings. =head1 SEE ALSO -For all related information (bug reporting, mailing-list, pointers to -MPD and POE, etc.), refer to C's pod, -section C +=over 4 + +=item L + +=item L + +=back =head1 AUTHOR diff --git a/lib/Audio/MPD/Common/Status.pm b/lib/Audio/MPD/Common/Status.pm index 7cf7dc3..ec54980 100644 --- a/lib/Audio/MPD/Common/Status.pm +++ b/lib/Audio/MPD/Common/Status.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -43,11 +43,9 @@ sub new { __END__ -=pod - =head1 NAME -POE::Component::Client::MPD::Status - class representing MPD status +Audio::MPD::Common::Status - class representing MPD status =head1 SYNOPSIS @@ -58,12 +56,11 @@ POE::Component::Client::MPD::Status - class representing MPD status =head1 DESCRIPTION The MPD server maintains some information on its current state. Those -information can be queried with the C message of C. -This method returns a C object, containing all -relevant information. +information can be queried with mpd modules. Some of those information +are served to you as an C object. -Note that a C object does B update itself regularly, -and thus should be used immediately. +Note that an C object does B update +itself regularly, and thus should be used immediately. =head1 METHODS @@ -74,12 +71,11 @@ and thus should be used immediately. =item new( \%kv ) -The C method is the constructor for the C class. -It is called internally by the C message handler of C, -with the result of the C command sent to MPD server. +The C method is the constructor for the C +class. -Note: one should B ever instantiate an C object -directly - use the C message of C. +Note: one should B ever instantiate an C +object directly - use the mpd modules instead. =back @@ -143,8 +139,8 @@ The state of MPD server. Either C, C or C. =item $status->time() -A C object, representing the time elapsed / remainging and -total. See the associated pod for more details. +An C object, representing the time elapsed / +remainging and total. See the associated pod for more details. =item $status->volume() @@ -160,15 +156,19 @@ The crossfade in seconds. =back Please note that those accessors are read-only: changing a value will B -change the current settings of MPD server. Use C messages to -alter the settings. +change the current settings of MPD server. Use the mpd modules to alter the +settings. =head1 SEE ALSO -For all related information (bug reporting, mailing-list, pointers to -MPD and POE, etc.), refer to C's pod, -section C +=over 4 + +=item L + +=item L + +=back =head1 AUTHOR diff --git a/lib/Audio/MPD/Common/Time.pm b/lib/Audio/MPD/Common/Time.pm index c07e68a..857d8f3 100644 --- a/lib/Audio/MPD/Common/Time.pm +++ b/lib/Audio/MPD/Common/Time.pm @@ -1,5 +1,5 @@ # -# This file is part of POE::Component::Client::MPD. +# This file is part of Audio::MPD::Common # Copyright (c) 2007 Jerome Quelin, all rights reserved. # # This program is free software; you can redistribute it and/or modify @@ -86,11 +86,9 @@ sub new { __END__ -=pod - =head1 NAME -POE::Component::Client::MPD::Time - class representing time of current song +Audio::MPD::Common::Time - class representing time of current song =head1 SYNOPSIS @@ -101,13 +99,13 @@ POE::Component::Client::MPD::Time - class representing time of current song =head1 DESCRIPTION -C returns some time information with the C +C returns some time information with the C accessor. This information relates to the elapsed time of the current song, as well as the remaining and total time. This information is encapsulated -in a C object. +in an C object. -Note that an C object does B update itself regularly, -and thus should be used immediately. +Note that an C object does B update itself +regularly, and thus should be used immediately. =head1 METHODS @@ -118,19 +116,18 @@ and thus should be used immediately. =item new( $time ) -The C method is the constructor for the C class. -It is called internally during the C object creation, -with the C