From a56080e3ee6edc366a62a79e237f2eb93298ff3f Mon Sep 17 00:00:00 2001 From: Stormwind Date: Thu, 19 Feb 2015 18:30:09 +0100 Subject: [PATCH] Add some doc --- lib/rubella.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/rubella.rb b/lib/rubella.rb index 73799f3..937f3bc 100644 --- a/lib/rubella.rb +++ b/lib/rubella.rb @@ -1,10 +1,19 @@ module Rubella + # Helps to process and create the heatmap + # class Map attr_reader :input attr_reader :output attr_reader :weighting + # Constructor + # + # @param input_name string Name of the input type in CamelCase + # @param output_name string Name of the output type in CamelCase + # @param weighting_name string Name of the weighting type in CamelCase + # @return Rubella::Map + # @raise NotImplementedError def initialize(input_name, output_name, weighting_name) # set the input type