ingredient_converter.rb in ingredient_converter-0.0.5

- old
+ new
@@ -1,8 +1,39 @@
+# encoding: UTF-8
+    # :title:US to UK ingredient measurement converter
+    # == Name
+    # USingredientConverter
+    # == Synopsis
+    # US to UK ingredient measurement converter
+    # == Description
+    # It is my final project for 2012 Fall Ruby language class, although it is still a work in progress as at 12.11.12
+    # == Todo
+    # === Upcoming Features
+    # 0. Ability to convert a stick of butter to not just ounces but to grams and tablespoons.  Also planned are from other types of measure such as flour, sugar, treacle.
+    # === Known Issues
+    # 0. Nothing yet 
+    # == References
+    # 0. Tim Myer
+    # == License
+    # This code is provided under the terms of the {MIT License.}[http://www.opensource.org/licenses/mit-license.php]
+    #--
+    # This code is the proprietary intellectual property of its authors. It is not intended for publication.
+    #++
+    # == Authors
+    # Nicole Lewis
+    #
 class USingredientConverter
+	# 
+	# * The method "convert" sole reponsibility is to convert the units-from parameter into the units-to parameter.
+	# * It will always return "4 ounces" as it is a stub as my face melted off attempting to get a hash inside a hash value by the deadline
+	# * I will make this more useful shortly
+	#
+	def convert(unitsfrom,unitsto)
+		return '4 ounces'
+	end
 end
\ No newline at end of file