Changeset 740


Ignore:
Timestamp:
06/04/15 15:57:40 (9 years ago)
Author:
Kris Deugau
Message:

/trunk

Clean up docucomment headers on a couple of subs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/cgi-bin/IPDB.pm

    r739 r740  
    10751075
    10761076## IPDB::listPool()
    1077 #
     1077# List the IPs in an IP pool.
     1078# Takes a pool/parent ID
     1079# Returns
     1080# Returns an arrayref to a list of hashrefs containing the IP, customer ID, availability flag,
     1081# description, backreference to the pool/parent, and the IP ID in the pool.
     1082# Also includes a "may be deleted" metaflag mainly useful for allowing the return to be passed
     1083# directly to HTML::Template for UI display.
    10781084sub listPool {
    10791085  my $dbh = shift;
     
    11531159## IPDB::getPoolSelect()
    11541160# Get a list of pools matching the passed city and type that have 1 or more free IPs
    1155 # Returns an arrayref to a list of hashrefs
     1161# Returns an arrayref to a list of hashrefs containing the number of available IPs, the CIDR pool,
     1162# and the city it's nominally in.
    11561163sub getPoolSelect {
    11571164  my $dbh = shift;
     
    11831190#  - optional master-block restriction
    11841191#  - optional flag to allow automatic pick-from-private-network-ranges
    1185 # Returns a string with the first CIDR block matching the criteria, if any
     1192# Returns a 3-element list with the free block ID, CIDR, and parent ID matching the criteria, if any
    11861193sub findAllocateFrom {
    11871194  my $dbh = shift;
Note: See TracChangeset for help on using the changeset viewer.