yard-api 0.3.6 → 0.3.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/LICENSE +70 -83
- data/lib/yard-api/version.rb +1 -1
- data/templates/api/fulldoc/html/css/highlight.css +1 -0
- data/templates/api/fulldoc/html/setup.rb +1 -1
- data/yard-api.gemspec +3 -3
- metadata +13 -15
- data/templates/api/fulldoc/html/css/highlight.css +0 -153
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b3af67e45e3ab8fd41ef0ec5cb1578e1978361579796e4d2720f9a09907ded38
|
4
|
+
data.tar.gz: 488360b56b9a807e8e6a8671b3aeae13b83f3400d01cf6f826b0cbdf9881337b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b1dfd66a16c6e4a1d76a121b2fc74ab9cd813e1336bb51ef36b6c54d9baea7e39fff89cb125759f784cb18d629259d340e655010a32f4709b85e43f92529f936
|
7
|
+
data.tar.gz: 85b89092da99271aad2c5b09b77ee32d5b1b93e25493ed16682263bed6cd3175c24c8ff21a4d3507fad9e3a5414b09079bae5c4bb095c3db4c0675a5a27bffdb
|
data/LICENSE
CHANGED
@@ -1,23 +1,21 @@
|
|
1
|
-
GNU GENERAL PUBLIC LICENSE
|
2
|
-
Version 3,
|
1
|
+
GNU AFFERO GENERAL PUBLIC LICENSE
|
2
|
+
Version 3, 19 November 2007
|
3
3
|
|
4
|
-
Copyright (C) 2007 Free Software Foundation, Inc. <
|
4
|
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
5
5
|
Everyone is permitted to copy and distribute verbatim copies
|
6
6
|
of this license document, but changing it is not allowed.
|
7
7
|
|
8
8
|
Preamble
|
9
9
|
|
10
|
-
The GNU General Public License is a free, copyleft license for
|
11
|
-
software and other kinds of works
|
10
|
+
The GNU Affero General Public License is a free, copyleft license for
|
11
|
+
software and other kinds of works, specifically designed to ensure
|
12
|
+
cooperation with the community in the case of network server software.
|
12
13
|
|
13
14
|
The licenses for most software and other practical works are designed
|
14
15
|
to take away your freedom to share and change the works. By contrast,
|
15
|
-
|
16
|
+
our General Public Licenses are intended to guarantee your freedom to
|
16
17
|
share and change all versions of a program--to make sure it remains free
|
17
|
-
software for all its users.
|
18
|
-
GNU General Public License for most of our software; it applies also to
|
19
|
-
any other work released this way by its authors. You can apply it to
|
20
|
-
your programs, too.
|
18
|
+
software for all its users.
|
21
19
|
|
22
20
|
When we speak of free software, we are referring to freedom, not
|
23
21
|
price. Our General Public Licenses are designed to make sure that you
|
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
|
|
26
24
|
want it, that you can change the software or use pieces of it in new
|
27
25
|
free programs, and that you know you can do these things.
|
28
26
|
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
that
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
products. If such problems arise substantially in other domains, we
|
58
|
-
stand ready to extend this provision to those domains in future versions
|
59
|
-
of the GPL, as needed to protect the freedom of users.
|
60
|
-
|
61
|
-
Finally, every program is threatened constantly by software patents.
|
62
|
-
States should not allow patents to restrict development and use of
|
63
|
-
software on general-purpose computers, but in those that do, we wish to
|
64
|
-
avoid the special danger that patents applied to a free program could
|
65
|
-
make it effectively proprietary. To prevent this, the GPL assures that
|
66
|
-
patents cannot be used to render the program non-free.
|
27
|
+
Developers that use our General Public Licenses protect your rights
|
28
|
+
with two steps: (1) assert copyright on the software, and (2) offer
|
29
|
+
you this License which gives you legal permission to copy, distribute
|
30
|
+
and/or modify the software.
|
31
|
+
|
32
|
+
A secondary benefit of defending all users' freedom is that
|
33
|
+
improvements made in alternate versions of the program, if they
|
34
|
+
receive widespread use, become available for other developers to
|
35
|
+
incorporate. Many developers of free software are heartened and
|
36
|
+
encouraged by the resulting cooperation. However, in the case of
|
37
|
+
software used on network servers, this result may fail to come about.
|
38
|
+
The GNU General Public License permits making a modified version and
|
39
|
+
letting the public access it on a server without ever releasing its
|
40
|
+
source code to the public.
|
41
|
+
|
42
|
+
The GNU Affero General Public License is designed specifically to
|
43
|
+
ensure that, in such cases, the modified source code becomes available
|
44
|
+
to the community. It requires the operator of a network server to
|
45
|
+
provide the source code of the modified version running there to the
|
46
|
+
users of that server. Therefore, public use of a modified version, on
|
47
|
+
a publicly accessible server, gives the public access to the source
|
48
|
+
code of the modified version.
|
49
|
+
|
50
|
+
An older license, called the Affero General Public License and
|
51
|
+
published by Affero, was designed to accomplish similar goals. This is
|
52
|
+
a different license, not a version of the Affero GPL, but Affero has
|
53
|
+
released a new version of the Affero GPL which permits relicensing under
|
54
|
+
this license.
|
67
55
|
|
68
56
|
The precise terms and conditions for copying, distribution and
|
69
57
|
modification follow.
|
@@ -72,7 +60,7 @@ modification follow.
|
|
72
60
|
|
73
61
|
0. Definitions.
|
74
62
|
|
75
|
-
"This License" refers to version 3 of the GNU General Public License.
|
63
|
+
"This License" refers to version 3 of the GNU Affero General Public License.
|
76
64
|
|
77
65
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
78
66
|
works, such as semiconductor masks.
|
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
|
|
549
537
|
the Program, the only way you could satisfy both those terms and this
|
550
538
|
License would be to refrain entirely from conveying the Program.
|
551
539
|
|
552
|
-
13. Use with the GNU
|
540
|
+
13. Remote Network Interaction; Use with the GNU General Public License.
|
541
|
+
|
542
|
+
Notwithstanding any other provision of this License, if you modify the
|
543
|
+
Program, your modified version must prominently offer all users
|
544
|
+
interacting with it remotely through a computer network (if your version
|
545
|
+
supports such interaction) an opportunity to receive the Corresponding
|
546
|
+
Source of your version by providing access to the Corresponding Source
|
547
|
+
from a network server at no charge, through some standard or customary
|
548
|
+
means of facilitating copying of software. This Corresponding Source
|
549
|
+
shall include the Corresponding Source for any work covered by version 3
|
550
|
+
of the GNU General Public License that is incorporated pursuant to the
|
551
|
+
following paragraph.
|
553
552
|
|
554
553
|
Notwithstanding any other provision of this License, you have
|
555
554
|
permission to link or combine any covered work with a work licensed
|
556
|
-
under version 3 of the GNU
|
555
|
+
under version 3 of the GNU General Public License into a single
|
557
556
|
combined work, and to convey the resulting work. The terms of this
|
558
557
|
License will continue to apply to the part which is the covered work,
|
559
|
-
but the
|
560
|
-
|
561
|
-
combination as such.
|
558
|
+
but the work with which it is combined will remain governed by version
|
559
|
+
3 of the GNU General Public License.
|
562
560
|
|
563
561
|
14. Revised Versions of this License.
|
564
562
|
|
565
563
|
The Free Software Foundation may publish revised and/or new versions of
|
566
|
-
the GNU General Public License from time to time. Such new versions
|
567
|
-
be similar in spirit to the present version, but may differ in detail to
|
564
|
+
the GNU Affero General Public License from time to time. Such new versions
|
565
|
+
will be similar in spirit to the present version, but may differ in detail to
|
568
566
|
address new problems or concerns.
|
569
567
|
|
570
568
|
Each version is given a distinguishing version number. If the
|
571
|
-
Program specifies that a certain numbered version of the GNU General
|
569
|
+
Program specifies that a certain numbered version of the GNU Affero General
|
572
570
|
Public License "or any later version" applies to it, you have the
|
573
571
|
option of following the terms and conditions either of that numbered
|
574
572
|
version or of any later version published by the Free Software
|
575
573
|
Foundation. If the Program does not specify a version number of the
|
576
|
-
GNU General Public License, you may choose any version ever published
|
574
|
+
GNU Affero General Public License, you may choose any version ever published
|
577
575
|
by the Free Software Foundation.
|
578
576
|
|
579
577
|
If the Program specifies that a proxy can decide which future
|
580
|
-
versions of the GNU General Public License can be used, that proxy's
|
578
|
+
versions of the GNU Affero General Public License can be used, that proxy's
|
581
579
|
public statement of acceptance of a version permanently authorizes you
|
582
580
|
to choose that version for the Program.
|
583
581
|
|
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
|
|
635
633
|
Copyright (C) <year> <name of author>
|
636
634
|
|
637
635
|
This program is free software: you can redistribute it and/or modify
|
638
|
-
it under the terms of the GNU General Public License as published by
|
636
|
+
it under the terms of the GNU Affero General Public License as published by
|
639
637
|
the Free Software Foundation, either version 3 of the License, or
|
640
638
|
(at your option) any later version.
|
641
639
|
|
642
640
|
This program is distributed in the hope that it will be useful,
|
643
641
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
644
642
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
645
|
-
GNU General Public License for more details.
|
643
|
+
GNU Affero General Public License for more details.
|
646
644
|
|
647
|
-
You should have received a copy of the GNU General Public License
|
648
|
-
along with this program. If not, see <
|
645
|
+
You should have received a copy of the GNU Affero General Public License
|
646
|
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
649
647
|
|
650
648
|
Also add information on how to contact you by electronic and paper mail.
|
651
649
|
|
652
|
-
If
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
The hypothetical commands `show w' and `show c' should show the appropriate
|
661
|
-
parts of the General Public License. Of course, your program's commands
|
662
|
-
might be different; for a GUI interface, you would use an "about box".
|
650
|
+
If your software can interact with users remotely through a computer
|
651
|
+
network, you should also make sure that it provides a way for users to
|
652
|
+
get its source. For example, if your program is a web application, its
|
653
|
+
interface could display a "Source" link that leads users to an archive
|
654
|
+
of the code. There are many ways you could offer source, and different
|
655
|
+
solutions will be better for different programs; see section 13 for the
|
656
|
+
specific requirements.
|
663
657
|
|
664
658
|
You should also get your employer (if you work as a programmer) or school,
|
665
659
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
666
|
-
For more information on this, and how to apply and follow the GNU
|
667
|
-
<
|
668
|
-
|
669
|
-
The GNU General Public License does not permit incorporating your program
|
670
|
-
into proprietary programs. If your program is a subroutine library, you
|
671
|
-
may consider it more useful to permit linking proprietary applications with
|
672
|
-
the library. If this is what you want to do, use the GNU Lesser General
|
673
|
-
Public License instead of this License. But first, please read
|
674
|
-
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
660
|
+
For more information on this, and how to apply and follow the GNU AGPL, see
|
661
|
+
<https://www.gnu.org/licenses/>.
|
data/lib/yard-api/version.rb
CHANGED
@@ -0,0 +1 @@
|
|
1
|
+
templates/api/fulldoc/html/css/../js/highlight/styles/mono-blue.css
|
@@ -118,7 +118,7 @@ def generate_code_objects(resources)
|
|
118
118
|
YARD::Registry.register co
|
119
119
|
|
120
120
|
(controller.tags(:object) + controller.tags(:model)).each do |tag|
|
121
|
-
id = YARD::CodeObjects::APIObject.sanitize_id(tag.text.lines
|
121
|
+
id = YARD::CodeObjects::APIObject.sanitize_id(tag.text.lines.first.strip)
|
122
122
|
tag_co = YARD::CodeObjects::APIObject.new(co, id)
|
123
123
|
tag_co.object = tag.object
|
124
124
|
|
data/yard-api.gemspec
CHANGED
@@ -14,8 +14,8 @@ Gem::Specification.new do |s|
|
|
14
14
|
s.files = Dir.glob("{config,lib,spec,templates,tasks}/**/*") +
|
15
15
|
['LICENSE', 'README.md', '.rspec', __FILE__]
|
16
16
|
s.has_rdoc = 'yard'
|
17
|
-
s.license = '
|
17
|
+
s.license = 'AGPL-3.0'
|
18
18
|
s.add_dependency 'yard', '0.8.7'
|
19
|
-
s.add_dependency 'yard-appendix'
|
20
|
-
s.add_development_dependency 'rspec'
|
19
|
+
s.add_dependency 'yard-appendix', '~> 0.1.8'
|
20
|
+
s.add_development_dependency 'rspec', '~> 3.3'
|
21
21
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard-api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.7
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ahmad Amireh
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2018-06-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: yard
|
@@ -28,32 +28,31 @@ dependencies:
|
|
28
28
|
name: yard-appendix
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- - "
|
31
|
+
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version:
|
33
|
+
version: 0.1.8
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
|
-
- - "
|
38
|
+
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version:
|
40
|
+
version: 0.1.8
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: rspec
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- - "
|
45
|
+
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '
|
47
|
+
version: '3.3'
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- - "
|
52
|
+
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: '
|
55
|
-
description:
|
56
|
-
TBD
|
54
|
+
version: '3.3'
|
55
|
+
description: " TBD\n"
|
57
56
|
email: ahmad@instructure.com
|
58
57
|
executables: []
|
59
58
|
extensions: []
|
@@ -189,7 +188,7 @@ files:
|
|
189
188
|
- yard-api.gemspec
|
190
189
|
homepage: https://github.com/amireh/yard-api
|
191
190
|
licenses:
|
192
|
-
-
|
191
|
+
- AGPL-3.0
|
193
192
|
metadata: {}
|
194
193
|
post_install_message:
|
195
194
|
rdoc_options: []
|
@@ -207,9 +206,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
207
206
|
version: '0'
|
208
207
|
requirements: []
|
209
208
|
rubyforge_project:
|
210
|
-
rubygems_version: 2.
|
209
|
+
rubygems_version: 2.7.6
|
211
210
|
signing_key:
|
212
211
|
specification_version: 4
|
213
212
|
summary: A YARD plugin for documenting APIs in Rails projects.
|
214
213
|
test_files: []
|
215
|
-
has_rdoc: yard
|
@@ -1,153 +0,0 @@
|
|
1
|
-
/*
|
2
|
-
|
3
|
-
Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiacs.Org>
|
4
|
-
|
5
|
-
*/
|
6
|
-
|
7
|
-
.hljs {
|
8
|
-
display: block;
|
9
|
-
overflow-x: auto;
|
10
|
-
padding: 0.5em;
|
11
|
-
background: #f0f0f0;
|
12
|
-
-webkit-text-size-adjust: none;
|
13
|
-
}
|
14
|
-
|
15
|
-
.hljs,
|
16
|
-
.hljs-subst,
|
17
|
-
.hljs-tag .hljs-title,
|
18
|
-
.nginx .hljs-title {
|
19
|
-
color: black;
|
20
|
-
}
|
21
|
-
|
22
|
-
.hljs-string,
|
23
|
-
.hljs-title,
|
24
|
-
.hljs-constant,
|
25
|
-
.hljs-parent,
|
26
|
-
.hljs-tag .hljs-value,
|
27
|
-
.hljs-rules .hljs-value,
|
28
|
-
.hljs-preprocessor,
|
29
|
-
.hljs-pragma,
|
30
|
-
.haml .hljs-symbol,
|
31
|
-
.ruby .hljs-symbol,
|
32
|
-
.ruby .hljs-symbol .hljs-string,
|
33
|
-
.hljs-template_tag,
|
34
|
-
.django .hljs-variable,
|
35
|
-
.smalltalk .hljs-class,
|
36
|
-
.hljs-addition,
|
37
|
-
.hljs-flow,
|
38
|
-
.hljs-stream,
|
39
|
-
.bash .hljs-variable,
|
40
|
-
.apache .hljs-tag,
|
41
|
-
.apache .hljs-cbracket,
|
42
|
-
.tex .hljs-command,
|
43
|
-
.tex .hljs-special,
|
44
|
-
.erlang_repl .hljs-function_or_atom,
|
45
|
-
.asciidoc .hljs-header,
|
46
|
-
.markdown .hljs-header,
|
47
|
-
.coffeescript .hljs-attribute {
|
48
|
-
color: #800;
|
49
|
-
}
|
50
|
-
|
51
|
-
.smartquote,
|
52
|
-
.hljs-comment,
|
53
|
-
.hljs-annotation,
|
54
|
-
.hljs-template_comment,
|
55
|
-
.diff .hljs-header,
|
56
|
-
.hljs-chunk,
|
57
|
-
.asciidoc .hljs-blockquote,
|
58
|
-
.markdown .hljs-blockquote {
|
59
|
-
color: #888;
|
60
|
-
}
|
61
|
-
|
62
|
-
.hljs-number,
|
63
|
-
.hljs-date,
|
64
|
-
.hljs-regexp,
|
65
|
-
.hljs-literal,
|
66
|
-
.hljs-hexcolor,
|
67
|
-
.smalltalk .hljs-symbol,
|
68
|
-
.smalltalk .hljs-char,
|
69
|
-
.go .hljs-constant,
|
70
|
-
.hljs-change,
|
71
|
-
.lasso .hljs-variable,
|
72
|
-
.makefile .hljs-variable,
|
73
|
-
.asciidoc .hljs-bullet,
|
74
|
-
.markdown .hljs-bullet,
|
75
|
-
.asciidoc .hljs-link_url,
|
76
|
-
.markdown .hljs-link_url {
|
77
|
-
color: #080;
|
78
|
-
}
|
79
|
-
|
80
|
-
.hljs-label,
|
81
|
-
.hljs-javadoc,
|
82
|
-
.ruby .hljs-string,
|
83
|
-
.hljs-decorator,
|
84
|
-
.hljs-filter .hljs-argument,
|
85
|
-
.hljs-localvars,
|
86
|
-
.hljs-array,
|
87
|
-
.hljs-attr_selector,
|
88
|
-
.hljs-important,
|
89
|
-
.hljs-pseudo,
|
90
|
-
.hljs-pi,
|
91
|
-
.haml .hljs-bullet,
|
92
|
-
.hljs-doctype,
|
93
|
-
.hljs-deletion,
|
94
|
-
.hljs-envvar,
|
95
|
-
.hljs-shebang,
|
96
|
-
.apache .hljs-sqbracket,
|
97
|
-
.nginx .hljs-built_in,
|
98
|
-
.tex .hljs-formula,
|
99
|
-
.erlang_repl .hljs-reserved,
|
100
|
-
.hljs-prompt,
|
101
|
-
.asciidoc .hljs-link_label,
|
102
|
-
.markdown .hljs-link_label,
|
103
|
-
.vhdl .hljs-attribute,
|
104
|
-
.clojure .hljs-attribute,
|
105
|
-
.asciidoc .hljs-attribute,
|
106
|
-
.lasso .hljs-attribute,
|
107
|
-
.coffeescript .hljs-property,
|
108
|
-
.hljs-phony {
|
109
|
-
color: #88f;
|
110
|
-
}
|
111
|
-
|
112
|
-
.hljs-keyword,
|
113
|
-
.hljs-id,
|
114
|
-
.hljs-title,
|
115
|
-
.hljs-built_in,
|
116
|
-
.css .hljs-tag,
|
117
|
-
.hljs-javadoctag,
|
118
|
-
.hljs-phpdoc,
|
119
|
-
.hljs-dartdoc,
|
120
|
-
.hljs-yardoctag,
|
121
|
-
.smalltalk .hljs-class,
|
122
|
-
.hljs-winutils,
|
123
|
-
.bash .hljs-variable,
|
124
|
-
.apache .hljs-tag,
|
125
|
-
.hljs-type,
|
126
|
-
.hljs-typename,
|
127
|
-
.tex .hljs-command,
|
128
|
-
.asciidoc .hljs-strong,
|
129
|
-
.markdown .hljs-strong,
|
130
|
-
.hljs-request,
|
131
|
-
.hljs-status {
|
132
|
-
font-weight: bold;
|
133
|
-
}
|
134
|
-
|
135
|
-
.asciidoc .hljs-emphasis,
|
136
|
-
.markdown .hljs-emphasis {
|
137
|
-
font-style: italic;
|
138
|
-
}
|
139
|
-
|
140
|
-
.nginx .hljs-built_in {
|
141
|
-
font-weight: normal;
|
142
|
-
}
|
143
|
-
|
144
|
-
.coffeescript .javascript,
|
145
|
-
.javascript .xml,
|
146
|
-
.lasso .markup,
|
147
|
-
.tex .hljs-formula,
|
148
|
-
.xml .javascript,
|
149
|
-
.xml .vbscript,
|
150
|
-
.xml .css,
|
151
|
-
.xml .hljs-cdata {
|
152
|
-
opacity: 0.5;
|
153
|
-
}
|