docster-rails 0.0.5 → 0.0.6
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/MIT-LICENSE +1 -1
- data/README.rdoc +1 -1
- data/lib/docster/doc_parser.rb +1 -1
- data/lib/docster/version.rb +1 -1
- metadata +8 -8
data/MIT-LICENSE
CHANGED
data/README.rdoc
CHANGED
@@ -27,7 +27,7 @@ Add a custom initializer such as config/initializers/docster.rb
|
|
27
27
|
|
28
28
|
== Using docster
|
29
29
|
|
30
|
-
Docster markup is added directly to your code as comments. A markup block starts with the
|
30
|
+
Docster markup is added directly to your code as comments. A markup block starts with the `# -- doc --` tag and ends with the `# -- /doc --` tag.
|
31
31
|
|
32
32
|
In your controllers or routes.rb file, add an object tag to start defining api calls for this object.
|
33
33
|
|
data/lib/docster/doc_parser.rb
CHANGED
@@ -32,7 +32,7 @@ module Docster
|
|
32
32
|
i = index + 1
|
33
33
|
while (i < lines.size && next_match = lines[i].match(/# [\s\t\r\n\f\@]+ (.+)$/))
|
34
34
|
new_line = "<br>"
|
35
|
-
new_line = "\n" if entry[:element] == 'example'
|
35
|
+
new_line = "\n" if entry[:element] == 'example' || entry[:element] == 'returns'
|
36
36
|
entry[:description] = entry[:description] + new_line + next_match[1]
|
37
37
|
i = i + 1
|
38
38
|
end
|
data/lib/docster/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: docster-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.6
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,11 +9,11 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-02-
|
12
|
+
date: 2012-02-13 00:00:00.000000000Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: rails
|
16
|
-
requirement: &
|
16
|
+
requirement: &70269638766380 !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
19
|
- - ! '>='
|
@@ -21,10 +21,10 @@ dependencies:
|
|
21
21
|
version: 3.1.0
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
|
-
version_requirements: *
|
24
|
+
version_requirements: *70269638766380
|
25
25
|
- !ruby/object:Gem::Dependency
|
26
26
|
name: sqlite3
|
27
|
-
requirement: &
|
27
|
+
requirement: &70269638765640 !ruby/object:Gem::Requirement
|
28
28
|
none: false
|
29
29
|
requirements:
|
30
30
|
- - ! '>='
|
@@ -32,7 +32,7 @@ dependencies:
|
|
32
32
|
version: '0'
|
33
33
|
type: :development
|
34
34
|
prerelease: false
|
35
|
-
version_requirements: *
|
35
|
+
version_requirements: *70269638765640
|
36
36
|
description: By adding simple markup to your controllers or routes.rb you can specify
|
37
37
|
your api doc.
|
38
38
|
email:
|
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
100
100
|
version: '0'
|
101
101
|
segments:
|
102
102
|
- 0
|
103
|
-
hash: -
|
103
|
+
hash: -943881780460002797
|
104
104
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
105
105
|
none: false
|
106
106
|
requirements:
|
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
109
109
|
version: '0'
|
110
110
|
segments:
|
111
111
|
- 0
|
112
|
-
hash: -
|
112
|
+
hash: -943881780460002797
|
113
113
|
requirements: []
|
114
114
|
rubyforge_project:
|
115
115
|
rubygems_version: 1.8.10
|