XOrg: POD the Module module.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

1 files changed, 35 insertions, 5 deletions

diff --git a/XOrg/Module.pm b/XOrg/Module.pm
index ebb2ae0..e841b89 100644
--- a/XOrg/Module.pm
+++ b/XOrg/Module.pm
@@ -19,7 +19,17 @@
 # Authors: Peter Hutterer <peter.hutterer@redhat.com>
 
 
-# X.Org driver module
+
+=head1 NAME
+
+XOrg::Module - Representation of an X.Org X Server loadable module
+
+=head1 DESCRIPTION
+
+An XOrg::Module is a module created by the Xorg.log parser.
+
+=cut
+
 
 package XOrg::Module;
 use Carp;
@@ -33,7 +43,12 @@ sub new {
 	 bless ($self, $class);
 }
 
-# Module name
+
+=head2 B<$module-E<gt>name([$name])>
+
+Returns the name of this module.
+
+=cut
 sub name {
 	 my $self = shift;
 	 my $name = shift;
@@ -42,7 +57,12 @@ sub name {
 	 return $self->{name};
 }
 
-# Version triplet of the module (2, 3, 0) for 2.3.0
+=head2 B<$module-E<gt>version([$major, $minor, $patchlevel])>
+
+Returns a list of (major, minor, patchlevel) for this module.
+
+=cut
+
 sub version {
 	 my $self = shift;
 	 my $major = shift;
@@ -56,7 +76,13 @@ sub version {
 	 return @{$self->{version}};
 }
 
-# ABI is a list of 3, e.g. ("input", 12, 2) for input ABI 12.2
+=head2 B<$module-E<gt>abi([$type, $major, $minor])>
+
+Returns a list of (type, major, minor) specifying the supported ABI for this
+module. Supported types are C<extension>, C<input>, and C<video>.
+
+=cut
+
 sub abi {
 	 my $self = shift;
 	 my $type = shift;
@@ -67,7 +93,11 @@ sub abi {
 	 return $self->{abi};
 }
 
-# Path to module
+=head2 B<$module-E<gt>path([$path])>
+
+Returns the path of the module.
+
+=cut
 sub path {
 	 my $self = shift;
 	 my $path = shift;