yard-rest 1.1.0 → 1.1.1

data/README.markdown

@@ -11,11 +11,11 @@ A plugin for [Yardoc](http://yardoc.org/) that generates documentation for RESTf
 
 It also requires the Jeweler gem if you plan to use the rake build tasks.
 
-## Fast Example
+## See an API-Example
 
-Run 'rake ex:generate' inside this plugin folder and get a look to the generated doc/index.html.
+[Yard-Rest-Plugin](http://spape.github.com/yard-rest-plugin) and get a look to the "Example" resource.
 
-## Demo
+## Demo (see the plugin in action)
 
 Visit [MAdeK-Api-Documetnation](http://medienarchiv.zhdk.ch/api) for a demonstration. Or visit ROR project [MAdeK](http://github.com/zhdk/madek) on github to see how we document our api.
 

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{A customized plugin for Yardoc that produces API documentation for Restful web services}
     gem.email = ''
     gem.homepage = "https://github.com/spape/yard-rest-plugin"
-    gem.authors = ['R. Kevin Nelson', 'Aisha Fenton', 'Sebastian Pape']
+    gem.authors = ['Sebastian Pape']
     gem.add_dependency("yard", '~>0.8.1')
     gem.files = Dir.glob("{lib,example,templates}/**/*").concat(["Rakefile"])
     gem.extra_rdoc_files = ['VERSION', 'README.markdown']

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/example/app/controllers/examples_controller.rb

@@ -21,7 +21,22 @@ class ExamplesController
   #
   # @example_request {}
   # @example_request_description Just requests an index of samples. 
-  # @example_response {"examples": [{"id":1, "title":"Animals", "text":"Dogs and cats are some.", "highlight":true}, {"id":2, "title":"Computers", "text":"Windows PC or Apple's Macintosh.", "highlight":false}]}
+  # @example_response 
+  #   ```json
+  #   {
+  #     "examples": [{
+  #       "id":1,
+  #       "title":"Animals",
+  #       "text":"Dogs and cats are some.",
+  #       "highlight":true
+  #     },{
+  #       "id":2,
+  #       "title":"Computers",
+  #       "text":"Windows PC or Apple's Macintosh.",
+  #       "highlight":false
+  #     }]
+  #   }
+  #   ```
   # @example_response_description Responds with the index of examples.
   # 
   # @example_request {"highlight": true}
@@ -90,7 +105,7 @@ class ExamplesController
   # @optional [Boolean] example.highlight The highlight status of the new example. (Default is false)
   #
   # @example_request {"example": {"title":"Fish", "text": "Angel- or Butterflyfish"}}
-  # @example_resuest_description Create a new example for fish.
+  # @example_request_description Create a new example for fish.
   # @example_response {}
   # @example_response_description Responds with an empty hash and status: 201 (Created).
   #

data/templates/default/layout/html/layout.erb

@@ -131,21 +131,21 @@
 			border-top-right-radius: 0;
 		}
 		
-		pre {
+		pre.code.json {
 		  margin: 0;
 		}
 		
-		pre code {
+		pre.code.json code {
 		  position: relative;
 		  border: 1px solid transparent;
 		  border-radius: 6px;
 		}
 		
-		pre code:hover {
+		pre.code.json code:hover {
 		  background: #d4e5fe;
 		}
 		
-		pre code:active {
+		pre.code.json code:active {
 		  background: #c1d8fb;
 		}
 	</style>

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yard-rest
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
-- R. Kevin Nelson
-- Aisha Fenton
 - Sebastian Pape
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard