perl-module: Document and test PSPP::Dict::get_var_cnt().

[pspp-builds.git] / perl-module / lib / PSPP.pm

diff --git a/perl-module/lib/PSPP.pm b/perl-module/lib/PSPP.pm
index 4eb8c41dd6f7fe36a3b8ec1ce9fe3ff522d9003d..2957abb90d419067951efec19d66794d75c90c15 100644 (file)
--- a/perl-module/lib/PSPP.pm
+++ b/perl-module/lib/PSPP.pm
@@ -87,9 +87,15 @@ sub new
 
 =pod
 
+=head3 get_var_cnt ()
+
+Returns the number of variables in the dictionary.
+
 =head3 get_var ($idx)
 
 Returns the C<idx>th variable from the dictionary.
+Returns undef if C<idx> is greater than or equal to the number
+of variables in the dictionary.
 
 =cut
 
@@ -491,7 +497,8 @@ This method returns an array of scalars, each of which are the values of
 the data in the system file.
 The first call to C<get_next_case> after C<open> has been called retrieves
 the first case in the system file.  Each subsequent call retrieves the next
-case.  If there are no more cases to be read, the function returns undef.
+case.  If there are no more cases to be read, the function returns an empty
+list.
 
 If the case contains system missing values, these values are set to the 
 empty string.