Document C::D::G::{Atom,Version}

[perl/modules/CPANPLUS-Dist-Gentoo.git] / lib / CPANPLUS / Dist / Gentoo / Version.pm

diff --git a/lib/CPANPLUS/Dist/Gentoo/Version.pm b/lib/CPANPLUS/Dist/Gentoo/Version.pm
index 1214582c08158b4909a18f307336e782000e405d..12f75d6e95dcb5235cecf7754a7911c92272116c 100644 (file)
--- a/lib/CPANPLUS/Dist/Gentoo/Version.pm
+++ b/lib/CPANPLUS/Dist/Gentoo/Version.pm
@@ -3,6 +3,24 @@ package CPANPLUS::Dist::Gentoo::Version;
 use strict;
 use warnings;
 
+=head1 NAME
+
+CPANPLUS::Dist::Gentoo::Version - Gentoo version object.
+
+=head1 VERSION
+
+Version 0.08
+
+=cut
+
+our $VERSION = '0.08';
+
+=head1 DESCRIPTION
+
+This class models Gentoo versions.
+
+=cut
+
 use Scalar::Util ();
 
 use overload (
@@ -10,13 +28,19 @@ use overload (
  '""'  => \&_stringify,
 );
 
-our $VERSION = '0.08';
-
 my $int_rx        = qr/\d+/;
 my $dotted_num_rx = qr/$int_rx(?:\.$int_rx)*/;
 
 our $version_rx = qr/$dotted_num_rx(?:_p$dotted_num_rx)?(?:-r$int_rx)?/;
 
+=head1 METHODS
+
+=head2 C<new $vstring>
+
+Creates a new L<CPANPLUS::Dist::Gentoo::Version> object from the version string C<$vstring>.
+
+=cut
+
 sub new {
  my $class = shift;
  $class = ref($class) || $class;
@@ -45,6 +69,20 @@ BEGIN {
  eval "sub $_ { \$_[0]->{$_} }" for @parts;
 }
 
+=head2 C<version>
+
+Read-only accessor for the C<version> part of the version object.
+
+=head2 C<patch>
+
+Read-only accessor for the C<patch> part of the version object.
+
+=head2 C<revision>
+
+Read-only accessor for the C<revision> part of the version object.
+
+=cut
+
 sub _spaceship {
  my ($v1, $v2, $r) = @_;
 
@@ -80,4 +118,36 @@ sub _stringify {
  $version;
 }
 
-1;
+=pod
+
+This class provides overloaded methods for numerical comparison and strigification.
+
+=head1 SEE ALSO
+
+L<CPANPLUS::Dist::Gentoo>.
+
+=head1 AUTHOR
+
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
+
+You can contact me by mail or on C<irc.perl.org> (vincent).
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-cpanplus-dist-gentoo at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CPANPLUS-Dist-Gentoo>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+    perldoc CPANPLUS::Dist::Gentoo
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2009 Vincent Pit, all rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
+
+=cut
+
+1; # End of CPANPLUS::Dist::Gentoo::Version