From 0f2da3230465df5df33113465bbab8e5a675438d Mon Sep 17 00:00:00 2001
From: Alex Reisner <alex@alexreisner.com>
Date: Tue, 15 Mar 2011 01:46:14 -0400
Subject: [PATCH] Add code comments.
---
lib/geocoder.rb | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/lib/geocoder.rb b/lib/geocoder.rb
index 23f67ab0..22f14105 100644
--- a/lib/geocoder.rb
+++ b/lib/geocoder.rb
@@ -42,7 +42,7 @@ module Geocoder
private # -----------------------------------------------------------------
##
- # Get the lookup object (which communicates with the remote geocoding API).
+ # Get a Lookup object (which communicates with the remote geocoding API).
# Returns an IP address lookup if +ip+ parameter true.
#
def lookup(ip = false)
@@ -53,6 +53,9 @@ module Geocoder
end
end
+ ##
+ # Retrieve a Lookup object from the store.
+ #
def get_lookup(name)
unless defined?(@lookups)
@lookups = {}
@@ -63,6 +66,9 @@ module Geocoder
@lookups[name]
end
+ ##
+ # Spawn a Lookup of the given name.
+ #
def spawn_lookup(name)
if valid_lookups.include?(name)
name = name.to_s
@@ -76,6 +82,9 @@ module Geocoder
end
end
+ ##
+ # Array of valid Lookup names.
+ #
def valid_lookups
[:google, :yahoo, :geocoder_ca, :freegeoip]
end
--
GitLab