yard-activerecord 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/README.md +19 -3
- data/lib/yard-activerecord/version.rb +1 -1
- data/yard-activerecord.gemspec +1 -1
- metadata +3 -3
data/README.md
CHANGED
|
@@ -5,13 +5,29 @@ applications with ActiveRecord. The extension handles attributes,
|
|
|
5
5
|
associations, delegates and scopes. A must for any Rails app using YARD as
|
|
6
6
|
documentation plugin.
|
|
7
7
|
|
|
8
|
+
|
|
9
|
+
## Installation ##
|
|
10
|
+
|
|
11
|
+
Run the following command in order to load YARD plugins:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
$ yard config load_plugins true
|
|
15
|
+
```
|
|
16
|
+
|
|
8
17
|
## Attributes ##
|
|
9
18
|
|
|
10
19
|
In order for this plugin to document any database attributes you need to add
|
|
11
|
-
`schema.rb` to your list of files. This is preferably done with in `.yardopts
|
|
20
|
+
`schema.rb` to your list of files. This is preferably done with in `.yardopts`
|
|
21
|
+
within your app project folder:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
# .yardopts
|
|
25
|
+
'app/**/*.rb'
|
|
26
|
+
'db/schema.rb'
|
|
27
|
+
```
|
|
12
28
|
|
|
13
|
-
|
|
14
|
-
before it can add the attributes.
|
|
29
|
+
It's important that the `schema.rb`-file is added at the end as it needs all
|
|
30
|
+
classes loaded before it can add the attributes.
|
|
15
31
|
|
|
16
32
|
The plugin will then document all attributes in your documentation.
|
|
17
33
|
|
data/yard-activerecord.gemspec
CHANGED
|
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
|
|
|
8
8
|
s.version = YARD::ActiveRecord::VERSION
|
|
9
9
|
s.authors = ["Theodor Tonum"]
|
|
10
10
|
s.email = ["theodor@tonum.no"]
|
|
11
|
-
s.homepage = ""
|
|
11
|
+
s.homepage = "https://github.com/theodorton/yard-activerecord"
|
|
12
12
|
s.summary = %q{ActiveRecord Handlers for YARD}
|
|
13
13
|
s.description = %q{
|
|
14
14
|
YARD-Activerecord is a YARD extension that handles and interprets methods
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard-activerecord
|
|
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,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2013-02-
|
|
12
|
+
date: 2013-02-23 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: yard
|
|
@@ -57,7 +57,7 @@ files:
|
|
|
57
57
|
- lib/yard-activerecord/version.rb
|
|
58
58
|
- test.rb
|
|
59
59
|
- yard-activerecord.gemspec
|
|
60
|
-
homepage:
|
|
60
|
+
homepage: https://github.com/theodorton/yard-activerecord
|
|
61
61
|
licenses: []
|
|
62
62
|
post_install_message:
|
|
63
63
|
rdoc_options: []
|