From a80c9857a9c50829a606fa442bbe66b620750411 Mon Sep 17 00:00:00 2001 From: David Precious Date: Thu, 23 Jul 2009 21:44:53 +0100 Subject: [PATCH] POD updates - use L<> to make links between documentation for various components. --- lib/Audio/MPD.pm | 20 ++++++++++---------- lib/Audio/MPD/Collection.pm | 32 ++++++++++++++++---------------- lib/Audio/MPD/Playlist.pm | 14 +++++++------- lib/Audio/MPD/Test.pm | 4 ++-- 4 files changed, 35 insertions(+), 35 deletions(-) diff --git a/lib/Audio/MPD.pm b/lib/Audio/MPD.pm index 818cf24..de6388d 100644 --- a/lib/Audio/MPD.pm +++ b/lib/Audio/MPD.pm @@ -602,12 +602,12 @@ command, and will disconnect after the command has been issued. This scheme is far from optimal, but allows us not to care about timeout disconnections. Because of that, the C command (new in mpd 0.14) is B (and will not) be supported in C. This will be -implemented in C. +implemented in L. B Note that C is using high-level, blocking sockets. This means that if the mpd server is slow, or hangs for whatever reason, or even crash abruptly, the program will be hung forever in this sub. -The C module is way safer - you're advised +The L module is way safer - you're advised to use it instead of C. Or you can try to set C to C<$REUSE> (see C constructor for more details), but you would be then on your own to deal with disconnections. @@ -726,32 +726,32 @@ output. =item $mpd->stats() -Return an C object with the current statistics +Return an L object with the current statistics of MPD. See the associated pod for more information. =item $mpd->status() -Return an C object with various information on +Return an L object with various information on current MPD server settings. Check the embedded pod for more information on the available accessors. =item $mpd->current() -Return an C representing the song currently +Return an L representing the song currently playing. =item $mpd->song( [$song] ) -Return an C representing the song number +Return an L representing the song number C<$song>. If C<$song> is not supplied, returns the current song. =item $mpd->songid( [$songid] ) -Return an C representing the song with id +Return an L representing the song with id C<$songid>. If C<$songid> is not supplied, returns the current song. =back @@ -840,11 +840,11 @@ current song. =head2 Searching the collection To search the collection, use the C accessor, returning the -associated C object. You will then be able to call: +associated L object. You will then be able to call: $mpd->collection->random_song; -See C documentation for more details on available +See L documentation for more details on available methods. @@ -855,7 +855,7 @@ associated C object. You will then be able to call: $mpd->playlist->clear; -See C documentation for more details on available +See L documentation for more details on available methods. diff --git a/lib/Audio/MPD/Collection.pm b/lib/Audio/MPD/Collection.pm index 9eecb2e..d2da0e7 100644 --- a/lib/Audio/MPD/Collection.pm +++ b/lib/Audio/MPD/Collection.pm @@ -335,13 +335,13 @@ of using the low-level methods provided by mpd itself. =item new( $mpd ) -This will create the object, holding a back-reference to the C +This will create the object, holding a back-reference to the L object itself (for communication purposes). But in order to play safe and to free the memory in time, this reference is weakened. Note that you're not supposed to call this constructor yourself, an -C is automatically created for you during the creation -of an C object. +L is automatically created for you during the creation +of an L object. =back @@ -352,7 +352,7 @@ of an C object. =item $coll->all_items( [$path] ) -Return B Cs (both songs & directories) +Return B Ls (both songs & directories) currently known by mpd. If C<$path> is supplied (relative to mpd root), restrict the retrieval to @@ -361,13 +361,13 @@ songs and dirs in this directory. =item $coll->all_items_simple( [$path] ) -Return B Cs (both songs & directories) +Return B Ls (both songs & directories) currently known by mpd. If C<$path> is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. -B: the C objects will only +B: the L objects will only have their tag C filled. Any other tag will be empty, so don't use this sub for any other thing than a quick scan! @@ -389,7 +389,7 @@ Note that this sub does not work recusrively on all directories. =item $coll->all_songs( [$path] ) -Return B Cs currently known by mpd. +Return B Ls currently known by mpd. If C<$path> is supplied (relative to mpd root), restrict the retrieval to songs and dirs in this directory. @@ -429,12 +429,12 @@ Return the list of all playlists (strings) currently known by mpd. =item $coll->song( $path ) -Return the C which correspond to C<$path>. +Return the L which correspond to C<$path>. =item $coll->songs_with_filename_partial( $string ) -Return the Cs containing C<$string> in +Return the Ls containing C<$string> in their path. @@ -453,35 +453,35 @@ participated. =item $coll->songs_by_artist( $artist ) -Return all Cs performed by C<$artist>. +Return all Ls performed by C<$artist>. =item $coll->songs_by_artist_partial( $string ) -Return all Cs performed by an artist +Return all Ls performed by an artist with C<$string> in her name. =item $coll->songs_from_album( $album ) -Return all Cs appearing in C<$album>. +Return all Ls appearing in C<$album>. =item $coll->songs_from_album_partial( $string ) -Return all Cs appearing in album +Return all Ls appearing in album containing C<$string>. =item $coll->songs_with_title( $title ) -Return all Cs which title is exactly +Return all Ls which title is exactly C<$title>. =item $coll->songs_with_title_partial( $string ) -Return all Cs where C<$string> is part +Return all Ls where C<$string> is part of the title. @@ -491,7 +491,7 @@ of the title. =head1 SEE ALSO For all related information (bug reporting, mailing-list, pointers to -MPD, etc.), refer to C's pod, section C +MPD, etc.), refer to L's pod, section C =head1 AUTHOR diff --git a/lib/Audio/MPD/Playlist.pm b/lib/Audio/MPD/Playlist.pm index 2cd1d78..4408818 100644 --- a/lib/Audio/MPD/Playlist.pm +++ b/lib/Audio/MPD/Playlist.pm @@ -261,7 +261,7 @@ __END__ =head1 NAME -Audio::MPD::Playlist - an object to mess MPD's playlist +Audio::MPD::Playlist - an object to interact with MPD's playlist =head1 SYNOPSIS @@ -271,7 +271,7 @@ Audio::MPD::Playlist - an object to mess MPD's playlist =head1 DESCRIPTION -C is a class meant to access & update MPD's +L is a class meant to access & update MPD's playlist. @@ -289,7 +289,7 @@ to free the memory in time, this reference is weakened. Note that you're not supposed to call this constructor yourself, an C is automatically created for you during the creation -of an C object. +of an L object. =back @@ -300,14 +300,14 @@ of an C object. =item $pl->as_items() -Return an array of Cs, one for each of the +Return an array of Ls, one for each of the songs in the current playlist. =item $pl->items_changed_since( $plversion ) -Return a list with all the songs (as AMC::Item::Song objects) added to -the playlist since playlist C<$plversion>. +Return a list with all the songs (as L objects) +added to the playlist since playlist C<$plversion>. =back @@ -410,7 +410,7 @@ return value. =head1 SEE ALSO For all related information (bug reporting, mailing-list, pointers to -MPD, etc.), refer to C's pod, section C +MPD, etc.), refer to L's pod, section C =head1 AUTHOR diff --git a/lib/Audio/MPD/Test.pm b/lib/Audio/MPD/Test.pm index cd91510..3ee6d60 100644 --- a/lib/Audio/MPD/Test.pm +++ b/lib/Audio/MPD/Test.pm @@ -151,7 +151,7 @@ Audio::MPD::Test - automate launching of fake mdp for testing purposes =head2 General usage This module will try to launch a new mpd server for testing purposes. This -mpd server will then be used during Audio::MPD tests. +mpd server will then be used during L tests. In order to achieve this, the module will create a fake mpd.conf file with the correct pathes (ie, where you untarred the module tarball). It will then @@ -200,7 +200,7 @@ This might be useful when trying to test connections with mpd server. =head1 SEE ALSO For all related information (bug reporting, mailing-list, pointers to -MPD, etc.), refer to C's pod, section C +MPD, etc.), refer to L's pod, section C =head1 AUTHOR -- 2.11.4.GIT