KerbalStuff 0.1.0 → 0.1.1

data/lib/KerbalStuff.rb

@@ -22,16 +22,28 @@ module KerbalStuff
 		response
 	end
 	
+	# Searches for mods with the specified keyword/phrase.
+	#
+	# @param query [String] the keyword/phrase to search for.
+	# @return [String] A parsed JSON output containing the mods which were found.
 	def self.SearchMod(query)
 		response = get_https_response("#{SEARCH_MOD}#{query}")
 		JSON.parse(response.body)
 	end
 	
+	# Searches for users with the specified keyword/phrase.
+	#
+	# @param query [String] the keyword/phrase to search for.
+	# @return [String] A parsed JSON output containing the users which were found.
 	def self.SearchUser(query)
 		response = get_https_response("#{SEARCH_USER}#{query}")
 		JSON.parse(response.body)
 	end
 	
+	# Retrieves information about the specified user.
+	#
+	# @param username [String] the username to retrieve its information.
+	# @return [String] A parsed JSON output containing the information about the user.
 	def self.User(username)
 		raise "username cannot be nil" unless username.length > 0
 		
@@ -39,6 +51,10 @@ module KerbalStuff
 		JSON.parse(response.body)
 	end
 
+	# Retrieves the information about the specified mod.
+	#
+	# @param id [Fixnum] the id to retrieve its information.
+	# @return [String] A parsed JSON output containing the information about the mod.
 	def self.Mod(id)
 		raise "id cannot be nil" unless id.is_a?(Integer) and id > 0
 		
@@ -46,6 +62,10 @@ module KerbalStuff
 		JSON.parse(response.body)
 	end
 	
+	# Retrieves the information about the slast released version of the specified mod.
+	#
+	# @param username [Fixnum] the id to retrieve information of its latest version released.
+	# @return [String] A parsed JSON output containing the information about the latest version released.
 	def self.GetLatestVersion(id)
 		raise "id cannot be nil" unless id.is_a?(Integer) and id > 0
 		

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: KerbalStuff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: