0
0
Fork 0

Add some more doc

This commit is contained in:
Stormwind 2015-02-19 22:40:38 +01:00
parent a56080e3ee
commit b337198350
1 changed files with 18 additions and 3 deletions

View File

@ -6,23 +6,38 @@ module Rubella
#
#
class JSON
attr_reader :data
# Constructor
# This constructer can create a new Rubella::Input::JSON object, but it
# is supposed to be private. Please use Rubella::Input::JSON.string or
# Rubella::Input::JSON.file to create a new instance.
#
# @param json__string string A string, which contains the data as json
# @return Rubella::Input::JSON
def initialize(json_string)
@data = ::JSON::load(json_string)
end
# Constructor
# Creates a new Rubella::Input::JSON object, from the given json.
#
# @param json_string string A string, which contains the data as json
# @return Rubella::Input::JSON
def self.string(json_string)
self.new(json_string)
end
# Constructor
# Creates a new Rubella::Input::JSON object, from the given file.
# Only the file name is required.
#
# @param json_file string The name of the file, which json contains
# @return Rubella:Input::JSON
def self.file(json_file)
self.new File.new(json_file, 'r')
end
# private :new
end
end