yard-rest 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.markdown +4 -0
- data/Rakefile +1 -1
- data/VERSION +1 -1
- metadata +3 -3
data/README.markdown
CHANGED
|
@@ -11,6 +11,10 @@ A plugin for [Yardoc](http://yardoc.org/) that generates documentation for RESTf
|
|
|
11
11
|
|
|
12
12
|
It also requires the Jeweler gem if you plan to use the rake build tasks.
|
|
13
13
|
|
|
14
|
+
## Demo
|
|
15
|
+
|
|
16
|
+
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.
|
|
17
|
+
|
|
14
18
|
## Generating Docs
|
|
15
19
|
|
|
16
20
|
When using yardoc you ask it to use the "rest" plugin (the --plugin option). For example:
|
data/Rakefile
CHANGED
|
@@ -6,7 +6,7 @@ begin
|
|
|
6
6
|
Jeweler::Tasks.new do |gem|
|
|
7
7
|
gem.name = "yard-rest"
|
|
8
8
|
gem.summary = %Q{A customized plugin for Yardoc that produces API documentation for Restful web services}
|
|
9
|
-
gem.description = %Q{A plugin for Yardoc that produces API documentation for Restful web services
|
|
9
|
+
gem.description = %Q{A customized plugin for Yardoc that produces API documentation for Restful web services}
|
|
10
10
|
gem.email = ''
|
|
11
11
|
gem.homepage = "https://github.com/spape/yard-rest-plugin"
|
|
12
12
|
gem.authors = ['R. Kevin Nelson', 'Aisha Fenton', 'Sebastian Pape']
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.1
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard-rest
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -29,8 +29,8 @@ dependencies:
|
|
|
29
29
|
- - ~>
|
|
30
30
|
- !ruby/object:Gem::Version
|
|
31
31
|
version: 0.7.4
|
|
32
|
-
description: A plugin for Yardoc that produces API documentation for Restful
|
|
33
|
-
|
|
32
|
+
description: A customized plugin for Yardoc that produces API documentation for Restful
|
|
33
|
+
web services
|
|
34
34
|
email: ''
|
|
35
35
|
executables: []
|
|
36
36
|
extensions: []
|