Changeset 740 for trunk/cgi-bin

Timestamp:

06/04/15 15:57:40 (10 years ago)

Author:

Kris Deugau

Message:

/trunk

Clean up docucomment headers on a couple of subs

File:

• trunk/cgi-bin/IPDB.pm (modified) (3 diffs)

trunk/cgi-bin/IPDB.pm

@@ -1075 +1075 @@
 
 ## IPDB::listPool()
-#
+# List the IPs in an IP pool.
+# Takes a pool/parent ID
+# Returns
+# Returns an arrayref to a list of hashrefs containing the IP, customer ID, availability flag,
+# description, backreference to the pool/parent, and the IP ID in the pool.
+# Also includes a "may be deleted" metaflag mainly useful for allowing the return to be passed
+# directly to HTML::Template for UI display.
 sub listPool {
   my $dbh = shift;
@@ -1153 +1159 @@
 ## IPDB::getPoolSelect()
 # Get a list of pools matching the passed city and type that have 1 or more free IPs
-# Returns an arrayref to a list of hashrefs
+# Returns an arrayref to a list of hashrefs containing the number of available IPs, the CIDR pool,
+# and the city it's nominally in.
 sub getPoolSelect {
   my $dbh = shift;
@@ -1183 +1190 @@
 #  - optional master-block restriction
 #  - optional flag to allow automatic pick-from-private-network-ranges
-# Returns a string with the first CIDR block matching the criteria, if any
+# Returns a 3-element list with the free block ID, CIDR, and parent ID matching the criteria, if any
 sub findAllocateFrom {
   my $dbh = shift;