Updated documentations

Author: giterlizzi

lib/URI/PackageURL.pm

@@ -17,7 +17,7 @@ use constant DEBUG => $ENV{PURL_DEBUG};
 
 use overload '""' => 'to_string', fallback => 1;
 
-our $VERSION = '2.23_7';
+our $VERSION = '2.23_8';
 our @EXPORT  = qw(encode_purl decode_purl);
 
 my $PURL_REGEXP = qr{^pkg:(([/]{1,})?)([A-Za-z][A-Za-z0-9\.\-]*)([/]{1,}).+};
@@ -363,6 +363,9 @@ sub _url_decode {
 1;
 
 __END__
+
+=encoding utf-8
+
 =head1 NAME
 
 URI::PackageURL - Perl extension for PURL (Package URL)
@@ -458,7 +461,7 @@ Components are separated by a specific character for unambiguous parsing.
 
 The definition for each components is:
 
-=over
+=over 2
 
 =item * "scheme": this is the URL scheme with the constant value of "pkg".
 One of the primary reason for this single scheme is to facilitate the future
@@ -486,7 +489,7 @@ Optional.
 
 C<cpan> is an official PURL type (L<https://github.com/package-url/purl-spec/blob/main/types-doc/cpan-definition.md>)
 
-=over
+=over 2
 
 =item * The default repository is C<https://www.cpan.org/>.
 
@@ -528,98 +531,94 @@ B<NOTE>: This is only to be used for compatibility purposes (it will be removed
 
 They are exported by default:
 
-=over
+=head3 B<encode_purl>
 
-=item $purl_string = encode_purl(%purl_components)
+    $purl_string = encode_purl(%purl_components)
 
 Converts the given PURL components to PURL string. Croaks on error.
 
 This function call is functionally identical to:
 
     $purl_string = URI::PackageURL->new(%purl_components)->to_string;
 
-=item $purl_components = decode_purl($purl_string)
+=head3 B<decode_purl>
+
+    $purl_components = decode_purl($purl_string)
 
 Converts the given PURL string to PURL components. Croaks on error.
 
 This function call is functionally identical to:
 
     $purl = URI::PackageURL->from_string($purl_string);
 
-=back
-
 =head2 OBJECT-ORIENTED INTERFACE
 
-=over
-
-=item $purl = URI::PackageURL->new(%components)
-
-Create new B<URI::PackageURL> instance using provided PURL components
-(type, name, version, etc).
+=head3 B<new>
 
-=item $purl = PURL->new(%components)
+    $purl = URI::PackageURL->new(%components)
+    $purl = PURL->new(%components)
 
-Create new B<URI::PackageURL> instance using provided PURL components
+Create new L<URI::PackageURL> instance using provided PURL components
 (type, name, version, etc).
 
-=item $purl->scheme
+=head3 B<scheme>
 
 The scheme is a constant with the value "pkg".
 
-=item $purl->type
+=head3 B<type>
 
 The package "type" or package "protocol" such as cpan, maven, npm, nuget, gem, pypi, etc.
 
-=item $purl->namespace
+=head3 B<namespace>
 
 Some name prefix such as a Maven groupid, a Docker image owner, a GitHub user or
 organization. Optional and type-specific.
 
-=item $purl->name
+=head3 B<name>
 
 The "name" of the package.
 
-=item $purl->version
+=head3 B<version>
 
 The "version" of the package.
 
-=item $purl->qualifiers
+=head3 B<qualifiers>
 
 Extra qualifying data for a package such as an OS, architecture, a distro, etc.
 
-=item $purl->subpath
+=head3 B<subpath>
 
 Extra subpath within a package, relative to the package root.
 
-=item $purl->to_string
+=head3 B<to_string>
 
 Stringify Package URL components.
 
-=item $purl->to_urls
+=head3 B<to_urls>
 
 Return B<download> and/or B<repository> URLs.
 
-=item $purl->download_url
+=head3 B<download_url>
 
 Return B<download> URL.
 
 See C<purl_to_urls> in L<URI::PackageURL::Util>.
 
-=item $purl->repository_url
+=head3 B<repository_url>
 
 Return B<repository> URL.
 
 See C<purl_to_urls> in L<URI::PackageURL::Util>.
 
-=item $purl->to_hash
+=head3 B<to_hash>
 
 Turn PURL components into a hash reference.
 
-=item $purl->definition
+=head3 B<definition>
 
 Return L<URI::PackageURL::Type> instance.
 
-=item $purl->clone
+=head3 B<clone>
 
 Clone PURL object.
 
@@ -630,7 +629,7 @@ Clone PURL object.
     say $cloned; # pkg:cpan/GDT/URI-PackageURL@1.00
     say $purl;   # pkg:cpan/GDT/URI-PackageURL@2.23
 
-=item $purl->TO_JSON
+=head3 B<TO_JSON>
 
 Helper method for JSON modules (L<JSON>, L<JSON::PP>, L<JSON::XS>, L<Cpanel::JSON::XS>, L<Mojo::JSON>, etc).
 
@@ -648,11 +647,13 @@ Helper method for JSON modules (L<JSON>, L<JSON::PP>, L<JSON::XS>, L<Cpanel::JSO
     #    "version" : "2.23"
     # }
 
-=item $purl = URI::PackageURL->from_string($purl_string);
+=head3 B<from_string>
 
-Converts the given PURL string to PURL components. Croaks on error.
+    $purl = URI::PackageURL->from_string($purl_string);
+    $purl = PURL->from_string($purl_string);
 
-=back
+Converts the given PURL string to PURL components and return L<URI::PackageURL>
+instance. Croaks on error.
 
 
 =head1 SUPPORT
@@ -675,7 +676,7 @@ L<https://github.com/giterlizzi/perl-URI-PackageURL>
 
 =head1 AUTHOR
 
-=over 4
+=over
 
 =item * Giuseppe Di Terlizzi <gdt@cpan.org>
 

lib/URI/PackageURL/Type.pm

@@ -13,7 +13,7 @@ use List::Util qw(first);
 
 use constant DEBUG => $ENV{PURL_DEBUG};
 
-our $VERSION = '2.23_7';
+our $VERSION = '2.23_8';
 
 
 my %ALGO_LENGTH = ('md5' => 32, 'sha1' => 40, 'sha256' => 64, 'sha384' => 96, 'sha512' => 128);
@@ -526,7 +526,7 @@ L<https://github.com/giterlizzi/perl-URI-PackageURL>
 
 =head1 AUTHOR
 
-=over 4
+=over
 
 =item * Giuseppe Di Terlizzi <gdt@cpan.org>
 

lib/URI/PackageURL/Util.pm

@@ -7,7 +7,7 @@ use warnings;
 
 use Exporter qw(import);
 
-our $VERSION = '2.23_7';
+our $VERSION = '2.23_8';
 our @EXPORT  = qw(purl_to_urls);
 
 
@@ -518,7 +518,7 @@ L<https://github.com/giterlizzi/perl-URI-PackageURL>
 
 =head1 AUTHOR
 
-=over 4
+=over
 
 =item * Giuseppe Di Terlizzi <gdt@cpan.org>
 

lib/URI/VersionRange.pm

@@ -21,7 +21,7 @@ use overload '""' => 'to_string', fallback => 1;
 
 BEGIN { *VERS:: = *URI::VersionRange:: }
 
-our $VERSION = '2.23_7';
+our $VERSION = '2.23_8';
 our @EXPORT  = qw(encode_vers decode_vers);
 
 my $VERS_REGEXP = qr{^vers:[a-z\\.\\-\\+][a-z0-9\\.\\-\\+]*/.+};
@@ -308,6 +308,9 @@ sub _pairwise {
 1;
 
 __END__
+
+=encoding utf-8
+
 =head1 NAME
 
 URI::VersionRange - Perl extension for VERS (Version Range Specifier)
@@ -380,50 +383,53 @@ L<TC54 - Software and system transparency|https://tc54.org/>
 
 They are exported by default:
 
-=over
+=head3 B<encode_vers>
 
-=item $vers_string = encode_vers(%params);
+    $vers_string = encode_vers(%params);
 
 Converts the given C<vers> components to "vers" string. Croaks on error.
 
 This function call is functionally identical to:
 
     $vers_string = URI::VersionRange->new(%params)->to_string;
 
-=item $vers = decode_vers($vers_string);
+=head3 B<decode_vers>
+
+    $vers = decode_vers($vers_string);
 
 Converts the given "vers" string to L<URI::VersionRange> object. Croaks on error.
 
 This function call is functionally identical to:
 
     $vers = URI::VersionRange->from_string($vers_string);
 
-=back
 
 =head2 OBJECT-ORIENTED INTERFACE
 
-=over
+=head3 B<new>
 
-=item $vers = URI::VersionRange->new( scheme => STRING, constraints => ARRAY )
+    $vers = URI::VersionRange->new( scheme => STRING, constraints => ARRAY )
+    $vers = VERS->new( scheme => STRING, constraints => ARRAY )
 
-Create new B<URI::VersionRange> instance using provided VERS components
+Create new L<URI::VersionRange> instance using provided VERS components
 (scheme, constraints).
 
-=item $vers = VERS->new( scheme => STRING, constraints => ARRAY )
-
-Create new B<URI::VersionRange> instance using provided VERS components
-(scheme, constraints).
+=head3 B<scheme>
 
-=item $vers->scheme
+    $vers->scheme
 
 By convention the versioning scheme should be the same as the L<URI::PackageURL>
 package C<type> for a given package ecosystem.
 
-=item $vers->constraints
+=head3 B<constraints>
+
+    $vers->constraints
 
 C<constraints> is ARRAY of L<URI::VersionRange::Constraint> object.
 
-=item $vers->contains($version)
+=head3 B<contains>
+
+    $vers->contains($version)
 
 Check if a version is contained within a range
 
@@ -435,33 +441,58 @@ Check if a version is contained within a range
 
 See L<URI::VersionRange::Version>.
 
-=item $vers->constraint_contains
+=head3 B<constraint_contains>
+
+    $vers->constraint_contains
 
 Check if a version is contained within a specific constraint.
 
 See L<URI::VersionRange::Version>.
 
-=item $vers->to_hash
+=head3 B<to_hash>
+
+    $vers->to_hash
 
 Turn VERS components into a hash reference.
 
-=item $vers->to_string
+=head3 B<to_string>
+
+    $vers->to_string
 
 Stringify VERS components.
 
-=item $vers->TO_JSON
+=head3 B<TO_JSON>
+
+    $vers->TO_JSON
 
 Helper method for JSON modules (L<JSON>, L<JSON::PP>, L<JSON::XS>, L<Mojo::JSON>, etc).
 
     use Mojo::JSON qw(encode_json);
 
-    say encode_json($vers);  # {"constraints":[{"comparator":">","version":"2.00"},{"comparator":"<","version":"2.23"}],"scheme":"cpan"}
+    say encode_json($vers);
 
-=item $vers = URI::VersionRange->from_string($vers_string);
+    # {
+    #   "constraints": [
+    #     {
+    #       "comparator": ">",
+    #       "version": "2.00"
+    #     },
+    #     {
+    #       "comparator": "<",
+    #       "version": "2.23"
+    #     }
+    #   ],
+    #   "scheme": "cpan"
+    # }
 
-Converts the given "vers" string to L<URI::VersionRange> object. Croaks on error.
 
-=back
+=head3 B<from_string>
+
+    $vers = URI::VersionRange->from_string($vers_string);
+    $vers = VERS->from_string($vers_string);
+
+Converts the given "vers" string to VERS components and return L<URI::VersionRange>
+instance. Croaks on error.
 
 
 =head1 SUPPORT
@@ -484,7 +515,7 @@ L<https://github.com/giterlizzi/perl-URI-PackageURL>
 
 =head1 AUTHOR
 
-=over 4
+=over
 
 =item * Giuseppe Di Terlizzi <gdt@cpan.org>