standards_data.rb in openstudio-standards-0.5.0.rc1

- old
+ new

@@ -113,21 +113,21 @@
 
   # Method to search through a hash for the objects that meets the
   # desired search criteria, as passed via a hash.
   # Returns an Array (empty if nothing found) of matching objects.
   #
-  # @param hash_of_objects [Hash] hash of objects to search through
+  # @param table_name [String] table name
   # @param search_criteria [Hash] hash of search criteria
   # @param capacity [Double] capacity of the object in question.  If capacity is supplied,
   #   the objects will only be returned if the specified capacity is between
   #   the minimum_capacity and maximum_capacity values.
   # @return [Array] returns an array of hashes, one hash per object.  Array is empty if no results.
   # @example Find all the schedule rules that match the name
   #   rules = model_find_objects(self, standards_data['schedules'], {'name'=>schedule_name})
   #   if rules.size == 0
   #     OpenStudio::logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Cannot find data for schedule: #{schedule_name}, will not be created.")
-  #     return false #TODO change to return empty optional schedule:ruleset?
+  #     return false # @todo change to return empty optional schedule:ruleset?
   #   end
   def model_find_objects(table_name: , search_criteria: {}, capacity:nil)
     #    matching_objects = hash_of_objects.clone
     #    #new
     #    puts "searching"
@@ -245,10 +245,10 @@
   # desired search criteria, as passed via a hash.  If capacity is supplied,
   # the object will only be returned if the specified capacity is between
   # the minimum_capacity and maximum_capacity values.
   #
   #
-  # @param hash_of_objects [Hash] hash of objects to search through
+  # @param table_name [String] table name
   # @param search_criteria [Hash] hash of search criteria
   # @param capacity [Double] capacity of the object in question.  If capacity is supplied,
   #   the objects will only be returned if the specified capacity is between
   #   the minimum_capacity and maximum_capacity values.
   # @return [Hash] Return tbe first matching object hash if successful, nil if not.
\ No newline at end of file