From: Marius Gavrilescu <marius@ieval.ro>
Date: Sat, 16 Apr 2016 16:32:18 +0000 (+0300)
Subject: Improve POD formatting
X-Git-Tag: 0.001001~3
X-Git-Url: http://git.ieval.ro/?a=commitdiff_plain;h=6765bc35d634346fb62423893eed48ecb0de1bc5;p=image-openalpr.git

Improve POD formatting
---

diff --git a/lib/Image/OpenALPR.pm b/lib/Image/OpenALPR.pm
index bc9d7aa..b1124a2 100644
--- a/lib/Image/OpenALPR.pm
+++ b/lib/Image/OpenALPR.pm
@@ -78,7 +78,7 @@ Takes one mandatory argument (the country rules to use, such as C<eu>
 or C<us>) and two optional arguments: a path to the configuration
 file, and a path to the runtime_data directory.
 
-Returns a new Image::OpenALPR instance. If initialization fails (for
+Returns a new Image::OpenALPR instance. If initialisation fails (for
 example, if the chosen country is not available) an exception is
 thrown.
 
@@ -109,8 +109,8 @@ Changes the country rules in use.
 =item $alpr->B<setPrewarp>(I<$prewarp>)
 
 Sets the camera calibration values, as obtained from the
-openalpr-utils-calibrate utility. Can also be set in the configuration
-file.
+C<openalpr-utils-calibrate> utility. Can also be set in the
+configuration file.
 
 =item $alpr->B<set_default_region>(I<$region>)
 
diff --git a/lib/Image/OpenALPR/PlateResult.pm b/lib/Image/OpenALPR/PlateResult.pm
index 6cf1651..3fcca2d 100644
--- a/lib/Image/OpenALPR/PlateResult.pm
+++ b/lib/Image/OpenALPR/PlateResult.pm
@@ -45,31 +45,44 @@ Image::OpenALPR::PlateResult - a license plate, as identified by OpenALPR
 
 =head1 DESCRIPTION
 
-Image::OpenALPR::PlateResult is a class representing a plate identified by OpenALPR. It offers the following methods:
+Image::OpenALPR::PlateResult is a class representing a plate
+identified by OpenALPR. It offers the following methods:
 
 =over
 
-=item B<plate>
+=item $plate->B<plate>
 
-The plate number that has the highest confidence value (likelihood of being correct).
+The plate number that has the highest confidence value (likelihood of
+being correct).
 
-=item B<confidence>
+=item $plate->B<confidence>
 
 The confidence value of the plate number returned by B<plate>.
 
-=item B<matches_template>
+=item $plate->B<matches_template>
 
-True if the plate matches the plate pattern chosen via the B<set_default_region> in L<Image::OpenALPR>, false otherwise (or if no region was chosen).
-=item B<coordinates>
+True if the plate matches the plate pattern chosen via the
+B<set_default_region> in L<Image::OpenALPR>, false otherwise (or if no
+region was chosen).
 
-In list context, returns a four element list representing the vertices of the license plate, numbered clock-wise from top-left. Each element is an arrayref with two elements: the X coordinate followed by the Y coordinate.
+=item $plate->B<coordinates>
 
-In scalar context, returns an arrayref to an array containing the list described above.
+In list context, returns a four element list representing the vertices
+of the license plate, numbered clock-wise from top-left. Each element
+is an arrayref with two elements: the X coordinate followed by the Y
+coordinate.
 
+In scalar context, returns an arrayref to an array containing the list
+described above.
 
-=item B<candidates>
+=item $plate->B<candidates>
 
-In list context, returns a list of candidate license numbers, in decreasing order of confidence. The first element coincides with the plate/confidence pair returned by the B<plate> and B<confidence> methods. Each element is a partial Image::OpenALPR::PlateResult object -- only the B<plate>, B<confidence> and B<matches_template> methods will return a meaningful value.
+In list context, returns a list of candidate license numbers, in
+decreasing order of confidence. The first element coincides with the
+plate/confidence pair returned by the B<plate> and B<confidence>
+methods. Each element is a partial Image::OpenALPR::PlateResult object
+-- only the B<plate>, B<confidence> and B<matches_template> methods
+will return a meaningful value.
 
 =back