From b04f5369bc96202277030974110758079e54b6a9 Mon Sep 17 00:00:00 2001
From: Tzafrir Cohen <tzafrir@cohens.org.il>
Date: Sun, 24 May 2009 17:38:34 +0300
Subject: POD fixes and TODOs

---
 lib/Asterisk/config.pm | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/lib/Asterisk/config.pm b/lib/Asterisk/config.pm
index dc88ebf..01211b8 100755
--- a/lib/Asterisk/config.pm
+++ b/lib/Asterisk/config.pm
@@ -667,17 +667,20 @@ Version 0.9 syntax incompitable with 0.8.
                                      [stream_data=>$string],
                                      [object variable]);
 
-Instantiates a new object of file. read data from stream_data or
+Instantiates a new object of file. Reads data from stream_data or
 file.
 
 
-=head1 OBJECT VARIABLE
+=head1 OBJECT VARIABLES
+
+FIXME: should all of those be documented in the POD (rather than
+in comments in the code?)
 
 =head2 file
 
-config file name and path.
-if file no exists (exp. data from stream_data ) you can't
-saving by C<save_file>.
+Config file name and path. Must be set.
+If file does exists (exp. data from C<stream_data>), you will not
+be able to save using L<save_file>.
 
 =head2 keep_resource_array
 
@@ -686,24 +689,25 @@ more memory, default enabled. use set_objvar to change it.
 
 =head2 reload_when_save
 
-when save done, auto call .
+When save done, auto call .
+
+Enabled by default. Use set_variable to change it.
 
-default enable. use set_variable to change it.
+FIXME: what is C<set_variable>?
 
 =head2 clean_when_reload
 
-when reload done, auto clean_assign with current object.
-default enable. use set_objvar to change it.
+When reload done, auto clean_assign with current object.
+
+Enabled by default. Use L<set_objvar> to change it.
 
 =head2 commit_list
 
-internal variable listed all command. 
-i suggest don't modify and change this variable.
+Internal variable listed all command. 
 
 =head2 parsed_conf
 
-internal variable of parsed. 
-i suggest don't modify and change this variable.
+Internal variable of parsed. 
 
 
 =head1 OBJECT READ METHOD
@@ -712,19 +716,20 @@ i suggest don't modify and change this variable.
 
     $sip_conf->get_objvar(var_name);
 
-return defined object variables.
+Return defined object variables.
 
 =head2 fetch_sections_list
 
     $sip_conf->fetch_sections_list();
 
-only return sections name list. does not include 'unsection'.
+List of sections (not including C<unsection>) in a file.
 
 =head2 fetch_sections_hashref
 
     $sip_conf->fetch_sections_hashref();
 
-this function return parsed config files data.
+Returns the config file parsed as a hash (section name -> section)
+of lists (list of lines).
 
 =head2 fetch_keys_list
 
-- 
cgit v1.2.3