Added docs

visionmedia · Jul 24, 2009 · 8003594 · 8003594
1 parent fe7d061
commit 8003594
Show file tree

Hide file tree

Showing 325 changed files with 57,890 additions and 9 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -5,14 +5,6 @@ Fast, feature rich Google Search client. Search web results, images,
 books, local, patents, blogs and news using an elegant Ruby API with
 only a single dependency.
 
-== Todo:
-
-* Mixins for arguments / validation ... refactor consts etc
-* add validate method since they are similar
-* Support all current arguments 
-* Generate / view rdoc
-* Promote
-
 == Dependencies 
 
 * json gem
@@ -68,7 +60,7 @@ Query strings are urlencoded when Search#get_uri is called, so there
 is no reason to do so manually.
 
   File.open('path/to/images.html', 'w+') do |file|
-    Google::Search.new(:image, :query => 'Cookies').each do |image|
+    Google::Search::Image.new(:query => 'Cookies').each do |image|
       file.write %(<img src="#{image.uri}">)
     end
   end

diff --git a/doc/classes/Google.html b/doc/classes/Google.html
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Google</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
+    <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+    <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
+</head>
+
+<body>     
+    <div class="banner">
+        <h1>
+            <span class="type">Module</span> 
+            Google 
+
+        </h1>
+        <ul class="files">
+
+            <li><a href="../files/lib/google-search/item/base_rb.html">lib/google-search/item/base.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/blog_rb.html">lib/google-search/item/blog.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/book_rb.html">lib/google-search/item/book.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/image_rb.html">lib/google-search/item/image.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/local_rb.html">lib/google-search/item/local.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/news_rb.html">lib/google-search/item/news.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/patent_rb.html">lib/google-search/item/patent.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/video_rb.html">lib/google-search/item/video.rb</a></li>
+
+            <li><a href="../files/lib/google-search/item/web_rb.html">lib/google-search/item/web.rb</a></li>
+
+            <li><a href="../files/lib/google-search/response_rb.html">lib/google-search/response.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/base_rb.html">lib/google-search/search/base.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/blog_rb.html">lib/google-search/search/blog.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/book_rb.html">lib/google-search/search/book.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/image_rb.html">lib/google-search/search/image.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/local_rb.html">lib/google-search/search/local.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/mixins/filter_rb.html">lib/google-search/search/mixins/filter.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/mixins/order_by_rb.html">lib/google-search/search/mixins/order_by.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/mixins/safety_level_rb.html">lib/google-search/search/mixins/safety_level.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/news_rb.html">lib/google-search/search/news.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/patent_rb.html">lib/google-search/search/patent.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/video_rb.html">lib/google-search/search/video.rb</a></li>
+
+            <li><a href="../files/lib/google-search/search/web_rb.html">lib/google-search/search/web.rb</a></li>
+
+            <li><a href="../files/lib/google-search/version_rb.html">lib/google-search/version.rb</a></li>
+
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+
+        <li><span class="type">CLASS</span> <a href="Google/Search.html">Google::Search</a></li>
+
+    </ul>
+
+
+
+
+
+
+
+</div>
+    </div>
+  </body>
+</html>