Bug #51709 for EBook-Tools: [Patch] POD nits

The attached patch (against 0.4.6) fixes some POD, which renders wrong, at least at search.cpan.org.

diff --git a/lib/EBook/Tools.pm b/lib/EBook/Tools.pm index 3d68da9..d0c4021 100644 --- a/lib/EBook/Tools.pm +++ b/lib/EBook/Tools.pm @@ -1677,7 +1677,7 @@ sub review :method } -=head2 C<rights('id' => 'identifier')> +=head2 C<< rights('id' => 'identifier') >> Returns a list containing the text of all of dc:rights or dc:copyrights (case-insensitive) entries in the e-book, or undef if diff --git a/lib/EBook/Tools/EReader.pm b/lib/EBook/Tools/EReader.pm index 7b3b76c..bd00f02 100644 --- a/lib/EBook/Tools/EReader.pm +++ b/lib/EBook/Tools/EReader.pm @@ -396,7 +396,7 @@ sub sidebars_html Writes the raw book text to disk in PML form (including all sidebars and footnotes) with the given filename. -If C<$filename> is not specified, writes to C<$self->filebase> with +If C<$filename> is not specified, writes to C<< $self->filebase >> with a ".html" extension. Returns the filename used on success, or undef if there was no text to @@ -469,7 +469,7 @@ sub write_images :method Writes the raw book text to disk in PML form (including all sidebars and footnotes) with the given filename. -If C<$filename> is not specified, writes to C<$self->filebase> with +If C<$filename> is not specified, writes to C<< $self->filebase >> with a ".pml" extension. Returns the filename used on success, or undef if there was no text to @@ -542,7 +542,7 @@ sub write_unknown_records :method =head2 C<Load($filename)> -Sets C<$self->{filename}> and then loads and parses the file specified +Sets C<< $self->{filename} >> and then loads and parses the file specified by C<$filename>, calling L</ParseRecord(%record)> on every record found. diff --git a/lib/EBook/Tools/PalmDoc.pm b/lib/EBook/Tools/PalmDoc.pm index 9b26d0d..f8e543f 100644 --- a/lib/EBook/Tools/PalmDoc.pm +++ b/lib/EBook/Tools/PalmDoc.pm @@ -84,11 +84,11 @@ unless($@){ $htmlsupport = 1; } Instantiates a new Ebook::Tools::PalmDoc object. To create a Palm Resource file instead of a Palm Database file, set -C<$self->{attributes}{resource}> to be true immediately after +C<< $self->{attributes}{resource} >> to be true immediately after construction. Create a new Doc object. By default, it's not a resource database. Setting -C<$self->{attributes}{resource}> to C<1> before any manipulations will +C<< $self->{attributes}{resource} >> to C<1> before any manipulations will cause it to become a resource database. =cut @@ -282,7 +282,7 @@ sub ParseResource :method ## no critic (Always unpack @_ first) =head2 C<ParseRecordBookmark($data,$currentrecord)> Parses bookmark records/resources, updating object attributes, most -notably C<$self->{bookmarks}>. +notably C<< $self->{bookmarks} >>. The C<$currentrecord> argument is optional, but without it the debugging information may be less useful. This is called @@ -325,7 +325,7 @@ sub ParseRecordBookmark :method ## no critic (Always unpack @_ first) =head2 C<ParseRecordText($data)> Parses text records, updating object attributes, most notably -appending text to C<$self->{text}>. +appending text to C<< $self->{text} >>. This is called automatically by L</ParseRecord()> and L</ParseResource()> as needed.