Add documentationv1.00

1 files changed, 50 insertions, 0 deletions

diff --git a/lib/Config/HAProxy/Node/Root.pm b/lib/Config/HAProxy/Node/Root.pm
index 656bb9f..ca6e575 100644
--- a/lib/Config/HAProxy/Node/Root.pm
+++ b/lib/Config/HAProxy/Node/Root.pm
@@ -4,6 +4,19 @@ use warnings;
 use parent 'Config::HAProxy::Node::Section';
 use Carp;
 
+=head1 NAME
+
+Config::HAProxy::Node::Root - root node of HAProxy configuration parse tree
+
+=head1 DESCRIPTION
+
+Objects of this class represent the topmost node in HAProxy configuration tree.
+Each parse tree contains exactly one object of this class. This node can be
+reached from every node in the tree by following its B<parent> attribute
+and is returned by the B<tree> method of B<Config::HAProxy> class.
+
+=cut
+
 sub new {
     my $class = shift;
     my $self = $class->SUPER::new(@_);
@@ -11,21 +24,58 @@ sub new {
     return $self;
 }
 
+=head1 METHODS
+
+=head2 is_root
+
+Always true.
+
+=head2 is_dirty
+
+    $bool = $node->is_dirty;
+
+Returns true if the tree is C<dirty>, i.e. it was modified since it has been
+created from the disk configuration file.
+
+=cut
+
 sub is_dirty {
     my $self = shift;
     return $self->{dirty}
 }
 
+=head2 mark_dirty
+
+    $node->mark_dirty;
+
+Sets the C<dirty> attribute.
+
+=cut
+
 sub mark_dirty {
     my $self = shift;
     $self->{dirty} = 1;
 }
 
+=head2 clear_dirty
+
+    $node->clear_dirty;
+
+Clears the C<dirty> attribute.
+
+=cut
+
 sub clear_dirty {
     my $self = shift;
     $self->{dirty} = 0;
 }
 
+=head1 SEE ALSO
+
+B<Config::HAProxy::Node>.
+
+=cut
+
 1;