jazzy 0.14.3 → 0.14.4
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.
- checksums.yaml +4 -4
- data/.github/workflows/Tests.yml +7 -7
- data/.rubocop.yml +62 -1
- data/CHANGELOG.md +34 -0
- data/Gemfile +1 -1
- data/Gemfile.lock +64 -74
- data/README.md +86 -14
- data/Rakefile +1 -1
- data/jazzy.gemspec +1 -1
- data/js/package-lock.json +13 -46
- data/js/package.json +2 -2
- data/lib/jazzy/config.rb +1 -1
- data/lib/jazzy/extensions/katex/css/katex.min.css +1 -1
- data/lib/jazzy/extensions/katex/js/katex.min.js +1 -1
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/search_builder.rb +1 -1
- data/lib/jazzy/source_declaration/access_control_level.rb +52 -64
- data/lib/jazzy/source_declaration/type.rb +4 -0
- data/lib/jazzy/sourcekitten.rb +16 -1
- data/lib/jazzy/stats.rb +1 -1
- data/lib/jazzy/symbol_graph/constraint.rb +6 -1
- data/lib/jazzy/symbol_graph/symbol.rb +2 -1
- data/lib/jazzy/symbol_graph.rb +1 -1
- data/lib/jazzy/themes/apple/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/fullwidth/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/jony/assets/js/jquery.min.js +2 -2
- data/spec/Moya.podspec +55 -0
- data/spec/integration_spec.rb +18 -3
- metadata +6 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 46b23a5fd216d0d68d6d48b094669c92fbbccdca52e5a7923a11429a9bdca958
|
|
4
|
+
data.tar.gz: 3d16963bbb5e8dac679125d548ba3652e45bd42354b151c9886006f2fa86d82c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9cb4e55db01ae8d541128f97bce1470f5c5b133e4925c24cacb3c234c242ed7978c23f94fb16f35e92455696ea9b012c914e7db4019e001de68eebcb016f1dc7
|
|
7
|
+
data.tar.gz: 0aa0c110530795c1c30a7b4c6f3ca4378fb9c40f5740c48ef3c04a6fb14e52f5daf39f1be0335d351902e94b23034b0b7ad29a01ae56ae262303245b44e63469
|
data/.github/workflows/Tests.yml
CHANGED
|
@@ -10,10 +10,10 @@ jobs:
|
|
|
10
10
|
danger_and_rubocop:
|
|
11
11
|
runs-on: ubuntu-latest
|
|
12
12
|
steps:
|
|
13
|
-
- uses: actions/checkout@
|
|
13
|
+
- uses: actions/checkout@v3
|
|
14
14
|
- uses: ruby/setup-ruby@v1
|
|
15
15
|
with:
|
|
16
|
-
ruby-version: 2
|
|
16
|
+
ruby-version: 3.2
|
|
17
17
|
bundler-cache: true
|
|
18
18
|
- name: Rubocop
|
|
19
19
|
run: |
|
|
@@ -25,23 +25,23 @@ jobs:
|
|
|
25
25
|
bundle exec danger --verbose
|
|
26
26
|
|
|
27
27
|
spec:
|
|
28
|
-
runs-on: macos-
|
|
28
|
+
runs-on: macos-13
|
|
29
29
|
continue-on-error: true
|
|
30
30
|
strategy:
|
|
31
31
|
matrix:
|
|
32
32
|
spec: ["objc_spec", "swift_spec", "cocoapods_spec"]
|
|
33
33
|
env:
|
|
34
|
-
DEVELOPER_DIR: /Applications/
|
|
34
|
+
DEVELOPER_DIR: /Applications/Xcode_15.0.app/Contents/Developer
|
|
35
35
|
steps:
|
|
36
|
-
- uses: actions/checkout@
|
|
36
|
+
- uses: actions/checkout@v3
|
|
37
37
|
with:
|
|
38
38
|
submodules: recursive
|
|
39
39
|
- uses: ruby/setup-ruby@v1
|
|
40
40
|
with:
|
|
41
|
-
ruby-version: 2
|
|
41
|
+
ruby-version: 3.2
|
|
42
42
|
bundler-cache: true
|
|
43
43
|
- name: Cache cocoapods
|
|
44
|
-
uses: actions/cache@
|
|
44
|
+
uses: actions/cache@v3
|
|
45
45
|
env:
|
|
46
46
|
cache-name: cocoapods
|
|
47
47
|
with:
|
data/.rubocop.yml
CHANGED
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
AllCops:
|
|
2
2
|
Exclude:
|
|
3
3
|
- ./spec/integration_specs/**/*
|
|
4
|
+
- ./spec/Moya.podspec
|
|
4
5
|
- ./vendor/**/*
|
|
5
6
|
- ./tmp/**/*
|
|
6
7
|
- ./SourceKitten/**/*
|
|
7
8
|
SuggestExtensions: false
|
|
8
9
|
TargetRubyVersion: 2.6
|
|
9
10
|
|
|
10
|
-
#- Pending Cops as of 1.
|
|
11
|
+
#- Pending Cops as of 1.56.3 ---------------------------------------------#
|
|
11
12
|
|
|
12
13
|
Gemspec/DeprecatedAttributeAssignment: # new in 1.30
|
|
13
14
|
Enabled: true
|
|
15
|
+
Gemspec/DevelopmentDependencies: # new in 1.44
|
|
16
|
+
Enabled: false
|
|
14
17
|
Gemspec/RequireMFA: # new in 1.23
|
|
15
18
|
Enabled: true
|
|
16
19
|
Layout/LineContinuationLeadingSpace: # new in 1.31
|
|
@@ -29,6 +32,10 @@ Lint/DeprecatedConstants: # (new in 1.8)
|
|
|
29
32
|
Enabled: true
|
|
30
33
|
Lint/DuplicateBranch: # (new in 1.3)
|
|
31
34
|
Enabled: true
|
|
35
|
+
Lint/DuplicateMagicComment: # new in 1.37
|
|
36
|
+
Enabled: true
|
|
37
|
+
Lint/DuplicateMatchPattern: # new in 1.50
|
|
38
|
+
Enabled: true
|
|
32
39
|
Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
|
|
33
40
|
Enabled: true
|
|
34
41
|
Lint/EmptyBlock: # (new in 1.1)
|
|
@@ -41,6 +48,8 @@ Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
|
|
|
41
48
|
Enabled: true
|
|
42
49
|
Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
|
|
43
50
|
Enabled: true
|
|
51
|
+
Lint/MixedCaseRange: # new in 1.53
|
|
52
|
+
Enabled: true
|
|
44
53
|
Lint/NonAtomicFileOperation: # new in 1.31
|
|
45
54
|
Enabled: true
|
|
46
55
|
Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
|
|
@@ -51,6 +60,8 @@ Lint/OrAssignmentToConstant: # (new in 1.9)
|
|
|
51
60
|
Enabled: true
|
|
52
61
|
Lint/RedundantDirGlobSort: # (new in 1.8)
|
|
53
62
|
Enabled: true
|
|
63
|
+
Lint/RedundantRegexpQuantifiers: # new in 1.53
|
|
64
|
+
Enabled: true
|
|
54
65
|
Lint/RefinementImportMethods: # new in 1.27
|
|
55
66
|
Enabled: true
|
|
56
67
|
Lint/RequireRangeParentheses: # new in 1.32
|
|
@@ -67,20 +78,34 @@ Lint/UnexpectedBlockArity: # (new in 1.5)
|
|
|
67
78
|
Enabled: true
|
|
68
79
|
Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
|
|
69
80
|
Enabled: true
|
|
81
|
+
Lint/UselessRescue: # new in 1.43
|
|
82
|
+
Enabled: true
|
|
70
83
|
Lint/UselessRuby2Keywords: # new in 1.23
|
|
71
84
|
Enabled: true
|
|
85
|
+
Metrics/CollectionLiteralLength: # new in 1.47
|
|
86
|
+
Enabled: true
|
|
72
87
|
Naming/BlockForwarding: # new in 1.24
|
|
73
88
|
Enabled: true
|
|
74
89
|
Naming/InclusiveLanguage: # (new in 1.18)
|
|
75
90
|
Enabled: true
|
|
76
91
|
Security/CompoundHash: # new in 1.28
|
|
77
92
|
Enabled: true
|
|
93
|
+
Style/ConcatArrayLiterals: # new in 1.41
|
|
94
|
+
Enabled: true
|
|
78
95
|
Security/IoMethods: # new in 1.22
|
|
79
96
|
Enabled: true
|
|
80
97
|
Style/ArgumentsForwarding: # (new in 1.1)
|
|
81
98
|
Enabled: true
|
|
99
|
+
Style/ArrayIntersect: # new in 1.40
|
|
100
|
+
Enabled: true
|
|
82
101
|
Style/CollectionCompact: # (new in 1.2)
|
|
83
102
|
Enabled: true
|
|
103
|
+
Style/ComparableClamp: # new in 1.44
|
|
104
|
+
Enabled: true
|
|
105
|
+
Style/DataInheritance: # new in 1.49
|
|
106
|
+
Enabled: true
|
|
107
|
+
Style/DirEmpty: # new in 1.48
|
|
108
|
+
Enabled: true
|
|
84
109
|
Style/DocumentDynamicEvalDefinition: # (new in 1.1)
|
|
85
110
|
Enabled: true
|
|
86
111
|
Style/EmptyHeredoc: # new in 1.32
|
|
@@ -89,8 +114,12 @@ Style/EndlessMethod: # (new in 1.8)
|
|
|
89
114
|
Enabled: true
|
|
90
115
|
Style/EnvHome: # new in 1.29
|
|
91
116
|
Enabled: true
|
|
117
|
+
Style/ExactRegexpMatch: # new in 1.51
|
|
118
|
+
Enabled: true
|
|
92
119
|
Style/FetchEnvVar: # new in 1.28
|
|
93
120
|
Enabled: true
|
|
121
|
+
Style/FileEmpty: # new in 1.48
|
|
122
|
+
Enabled: true
|
|
94
123
|
Style/FileRead: # new in 1.24
|
|
95
124
|
Enabled: true
|
|
96
125
|
Style/FileWrite: # new in 1.24
|
|
@@ -109,6 +138,10 @@ Style/MapCompactWithConditionalBlock: # new in 1.30
|
|
|
109
138
|
Enabled: true
|
|
110
139
|
Style/MapToHash: # new in 1.24
|
|
111
140
|
Enabled: true
|
|
141
|
+
Style/MapToSet: # new in 1.42
|
|
142
|
+
Enabled: true
|
|
143
|
+
Style/MinMaxComparison: # new in 1.42
|
|
144
|
+
Enabled: true
|
|
112
145
|
Style/MultilineInPatternThen: # (new in 1.16)
|
|
113
146
|
Enabled: true
|
|
114
147
|
Style/NegatedIfElseCondition: # (new in 1.2)
|
|
@@ -125,20 +158,48 @@ Style/ObjectThen: # new in 1.28
|
|
|
125
158
|
Enabled: true
|
|
126
159
|
Style/OpenStructUse: # new in 1.23
|
|
127
160
|
Enabled: true
|
|
161
|
+
Style/OperatorMethodCall: # new in 1.37
|
|
162
|
+
Enabled: true
|
|
128
163
|
Style/QuotedSymbols: # (new in 1.16)
|
|
129
164
|
Enabled: true
|
|
130
165
|
Style/RedundantArgument: # (new in 1.4)
|
|
131
166
|
Enabled: true
|
|
167
|
+
Style/RedundantArrayConstructor: # new in 1.52
|
|
168
|
+
Enabled: true
|
|
169
|
+
Style/RedundantConstantBase: # new in 1.40
|
|
170
|
+
Enabled: true
|
|
171
|
+
Style/RedundantCurrentDirectoryInPath: # new in 1.53
|
|
172
|
+
Enabled: true
|
|
173
|
+
Style/RedundantDoubleSplatHashBraces: # new in 1.41
|
|
174
|
+
Enabled: true
|
|
175
|
+
Style/RedundantEach: # new in 1.38
|
|
176
|
+
Enabled: true
|
|
177
|
+
Style/RedundantFilterChain: # new in 1.52
|
|
178
|
+
Enabled: true
|
|
179
|
+
Style/RedundantHeredocDelimiterQuotes: # new in 1.45
|
|
180
|
+
Enabled: true
|
|
132
181
|
Style/RedundantInitialize: # new in 1.27
|
|
133
182
|
Enabled: true
|
|
183
|
+
Style/RedundantLineContinuation: # new in 1.49
|
|
184
|
+
Enabled: true
|
|
185
|
+
Style/RedundantRegexpArgument: # new in 1.53
|
|
186
|
+
Enabled: true
|
|
187
|
+
Style/RedundantRegexpConstructor: # new in 1.52
|
|
188
|
+
Enabled: true
|
|
134
189
|
Style/RedundantSelfAssignmentBranch: # (new in 1.19)
|
|
135
190
|
Enabled: true
|
|
191
|
+
Style/RedundantStringEscape: # new in 1.37
|
|
192
|
+
Enabled: true
|
|
193
|
+
Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
|
|
194
|
+
Enabled: true
|
|
136
195
|
Style/SelectByRegexp: # new in 1.22
|
|
137
196
|
Enabled: true
|
|
138
197
|
Style/StringChars: # (new in 1.12)
|
|
139
198
|
Enabled: true
|
|
140
199
|
Style/SwapValues: # (new in 1.1)
|
|
141
200
|
Enabled: true
|
|
201
|
+
Style/YAMLFileRead: # new in 1.53
|
|
202
|
+
Enabled: true
|
|
142
203
|
|
|
143
204
|
# At the moment not ready to be used
|
|
144
205
|
# https://github.com/bbatsov/rubocop/issues/947
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,37 @@
|
|
|
1
|
+
## 0.14.4
|
|
2
|
+
|
|
3
|
+
##### Breaking
|
|
4
|
+
|
|
5
|
+
* None.
|
|
6
|
+
|
|
7
|
+
##### Enhancements
|
|
8
|
+
|
|
9
|
+
* Update Javascript: jQuery 3.7.1, KaTeX 0.16.8
|
|
10
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
11
|
+
|
|
12
|
+
* Support Swift `package` access control level.
|
|
13
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
14
|
+
|
|
15
|
+
* Initial support for Swift macro declarations. Requires
|
|
16
|
+
`--swift-build-tool symbolgraph`.
|
|
17
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
18
|
+
|
|
19
|
+
* Support Swift `@_documentation(visibility:)` attribute. Requires
|
|
20
|
+
`--swift-build-tool spm|xcodebuild`.
|
|
21
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
22
|
+
|
|
23
|
+
##### Bug Fixes
|
|
24
|
+
|
|
25
|
+
* Issue a warning instead of crashing on declarations without names.
|
|
26
|
+
[#1325](https://github.com/realm/jazzy/issues/1325)
|
|
27
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
28
|
+
|
|
29
|
+
* Fix extension ordering in symbolgraph mode.
|
|
30
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
31
|
+
|
|
32
|
+
* Fix symbolgraph mode crash involving tuple generic constraints.
|
|
33
|
+
[John Fairhurst](https://github.com/johnfairh)
|
|
34
|
+
|
|
1
35
|
## 0.14.3
|
|
2
36
|
|
|
3
37
|
##### Breaking
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,13 +1,21 @@
|
|
|
1
|
+
GIT
|
|
2
|
+
remote: https://github.com/mrackwitz/CLIntegracon.git
|
|
3
|
+
revision: ca88b7b8920b6b6542f9b4ad2b1748855783dbae
|
|
4
|
+
specs:
|
|
5
|
+
clintegracon (0.9.0)
|
|
6
|
+
colored2 (~> 3.1)
|
|
7
|
+
diffy
|
|
8
|
+
|
|
1
9
|
PATH
|
|
2
10
|
remote: .
|
|
3
11
|
specs:
|
|
4
|
-
jazzy (0.14.
|
|
12
|
+
jazzy (0.14.4)
|
|
5
13
|
cocoapods (~> 1.5)
|
|
6
14
|
mustache (~> 1.1)
|
|
7
15
|
open4 (~> 1.3)
|
|
8
16
|
redcarpet (~> 3.4)
|
|
9
17
|
rexml (~> 3.2)
|
|
10
|
-
rouge (>= 2.0.6, <
|
|
18
|
+
rouge (>= 2.0.6, < 5.0)
|
|
11
19
|
sassc (~> 2.1)
|
|
12
20
|
sqlite3 (~> 1.3)
|
|
13
21
|
xcinvoke (~> 0.3.0)
|
|
@@ -15,15 +23,14 @@ PATH
|
|
|
15
23
|
GEM
|
|
16
24
|
remote: https://rubygems.org/
|
|
17
25
|
specs:
|
|
18
|
-
CFPropertyList (3.0.
|
|
26
|
+
CFPropertyList (3.0.6)
|
|
19
27
|
rexml
|
|
20
|
-
activesupport (
|
|
28
|
+
activesupport (7.0.8)
|
|
21
29
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
|
22
30
|
i18n (>= 1.6, < 2)
|
|
23
31
|
minitest (>= 5.1)
|
|
24
32
|
tzinfo (~> 2.0)
|
|
25
|
-
|
|
26
|
-
addressable (2.8.1)
|
|
33
|
+
addressable (2.8.5)
|
|
27
34
|
public_suffix (>= 2.0.2, < 6.0)
|
|
28
35
|
algoliasearch (1.27.5)
|
|
29
36
|
httpclient (~> 2.8, >= 2.8.3)
|
|
@@ -31,23 +38,21 @@ GEM
|
|
|
31
38
|
ast (2.4.2)
|
|
32
39
|
atomos (0.1.3)
|
|
33
40
|
bacon (1.2.0)
|
|
41
|
+
base64 (0.1.1)
|
|
34
42
|
claide (1.1.0)
|
|
35
43
|
claide-plugins (0.9.2)
|
|
36
44
|
cork
|
|
37
45
|
nap
|
|
38
46
|
open4 (~> 1.3)
|
|
39
|
-
|
|
40
|
-
colored (~> 1.2)
|
|
41
|
-
diffy
|
|
42
|
-
cocoapods (1.11.3)
|
|
47
|
+
cocoapods (1.12.1)
|
|
43
48
|
addressable (~> 2.8)
|
|
44
49
|
claide (>= 1.0.2, < 2.0)
|
|
45
|
-
cocoapods-core (= 1.
|
|
50
|
+
cocoapods-core (= 1.12.1)
|
|
46
51
|
cocoapods-deintegrate (>= 1.0.3, < 2.0)
|
|
47
|
-
cocoapods-downloader (>= 1.
|
|
52
|
+
cocoapods-downloader (>= 1.6.0, < 2.0)
|
|
48
53
|
cocoapods-plugins (>= 1.0.0, < 2.0)
|
|
49
54
|
cocoapods-search (>= 1.0.0, < 2.0)
|
|
50
|
-
cocoapods-trunk (>= 1.
|
|
55
|
+
cocoapods-trunk (>= 1.6.0, < 2.0)
|
|
51
56
|
cocoapods-try (>= 1.1.0, < 2.0)
|
|
52
57
|
colored2 (~> 3.1)
|
|
53
58
|
escape (~> 0.0.4)
|
|
@@ -55,10 +60,10 @@ GEM
|
|
|
55
60
|
gh_inspector (~> 1.0)
|
|
56
61
|
molinillo (~> 0.8.0)
|
|
57
62
|
nap (~> 1.0)
|
|
58
|
-
ruby-macho (>=
|
|
63
|
+
ruby-macho (>= 2.3.0, < 3.0)
|
|
59
64
|
xcodeproj (>= 1.21.0, < 2.0)
|
|
60
|
-
cocoapods-core (1.
|
|
61
|
-
activesupport (>= 5.0, <
|
|
65
|
+
cocoapods-core (1.12.1)
|
|
66
|
+
activesupport (>= 5.0, < 8)
|
|
62
67
|
addressable (~> 2.8)
|
|
63
68
|
algoliasearch (~> 1.0)
|
|
64
69
|
concurrent-ruby (~> 1.1)
|
|
@@ -76,131 +81,117 @@ GEM
|
|
|
76
81
|
nap (>= 0.8, < 2.0)
|
|
77
82
|
netrc (~> 0.11)
|
|
78
83
|
cocoapods-try (1.2.0)
|
|
79
|
-
colored (1.2)
|
|
80
84
|
colored2 (3.1.2)
|
|
81
|
-
concurrent-ruby (1.
|
|
85
|
+
concurrent-ruby (1.2.2)
|
|
82
86
|
cork (0.3.0)
|
|
83
87
|
colored2 (~> 3.1)
|
|
84
88
|
crack (0.4.5)
|
|
85
89
|
rexml
|
|
86
|
-
danger (
|
|
90
|
+
danger (9.3.1)
|
|
87
91
|
claide (~> 1.0)
|
|
88
92
|
claide-plugins (>= 0.9.2)
|
|
89
93
|
colored2 (~> 3.1)
|
|
90
94
|
cork (~> 0.1)
|
|
91
|
-
faraday (>= 0.9.0, <
|
|
95
|
+
faraday (>= 0.9.0, < 3.0)
|
|
92
96
|
faraday-http-cache (~> 2.0)
|
|
93
|
-
git (~> 1.
|
|
97
|
+
git (~> 1.13)
|
|
94
98
|
kramdown (~> 2.3)
|
|
95
99
|
kramdown-parser-gfm (~> 1.0)
|
|
96
100
|
no_proxy_fix
|
|
97
|
-
octokit (~>
|
|
101
|
+
octokit (~> 6.0)
|
|
98
102
|
terminal-table (>= 1, < 4)
|
|
99
103
|
diffy (3.4.2)
|
|
100
104
|
escape (0.0.4)
|
|
101
|
-
ethon (0.
|
|
105
|
+
ethon (0.16.0)
|
|
102
106
|
ffi (>= 1.15.0)
|
|
103
|
-
faraday (
|
|
104
|
-
|
|
105
|
-
faraday-
|
|
106
|
-
faraday-excon (~> 1.1)
|
|
107
|
-
faraday-httpclient (~> 1.0)
|
|
108
|
-
faraday-multipart (~> 1.0)
|
|
109
|
-
faraday-net_http (~> 1.0)
|
|
110
|
-
faraday-net_http_persistent (~> 1.0)
|
|
111
|
-
faraday-patron (~> 1.0)
|
|
112
|
-
faraday-rack (~> 1.0)
|
|
113
|
-
faraday-retry (~> 1.0)
|
|
107
|
+
faraday (2.7.11)
|
|
108
|
+
base64
|
|
109
|
+
faraday-net_http (>= 2.0, < 3.1)
|
|
114
110
|
ruby2_keywords (>= 0.0.4)
|
|
115
|
-
faraday-
|
|
116
|
-
faraday-em_synchrony (1.0.0)
|
|
117
|
-
faraday-excon (1.1.0)
|
|
118
|
-
faraday-http-cache (2.4.1)
|
|
111
|
+
faraday-http-cache (2.5.0)
|
|
119
112
|
faraday (>= 0.8)
|
|
120
|
-
faraday-
|
|
121
|
-
faraday-multipart (1.0.4)
|
|
122
|
-
multipart-post (~> 2)
|
|
123
|
-
faraday-net_http (1.0.1)
|
|
124
|
-
faraday-net_http_persistent (1.2.0)
|
|
125
|
-
faraday-patron (1.0.0)
|
|
126
|
-
faraday-rack (1.0.0)
|
|
127
|
-
faraday-retry (1.0.3)
|
|
113
|
+
faraday-net_http (3.0.2)
|
|
128
114
|
ffi (1.15.5)
|
|
129
115
|
fourflusher (2.3.1)
|
|
130
116
|
fuzzy_match (2.0.4)
|
|
131
117
|
gh_inspector (1.1.3)
|
|
132
|
-
git (1.
|
|
118
|
+
git (1.18.0)
|
|
133
119
|
addressable (~> 2.8)
|
|
134
120
|
rchardet (~> 1.8)
|
|
135
121
|
hashdiff (1.0.1)
|
|
136
122
|
httpclient (2.8.3)
|
|
137
|
-
i18n (1.
|
|
123
|
+
i18n (1.14.1)
|
|
138
124
|
concurrent-ruby (~> 1.0)
|
|
139
|
-
json (2.6.
|
|
125
|
+
json (2.6.3)
|
|
140
126
|
kramdown (2.4.0)
|
|
141
127
|
rexml
|
|
142
128
|
kramdown-parser-gfm (1.1.0)
|
|
143
129
|
kramdown (~> 2.0)
|
|
130
|
+
language_server-protocol (3.17.0.3)
|
|
144
131
|
liferaft (0.0.6)
|
|
145
|
-
mini_portile2 (2.8.
|
|
146
|
-
minitest (5.
|
|
147
|
-
mocha (1.
|
|
132
|
+
mini_portile2 (2.8.4)
|
|
133
|
+
minitest (5.20.0)
|
|
134
|
+
mocha (2.1.0)
|
|
135
|
+
ruby2_keywords (>= 0.0.5)
|
|
148
136
|
mocha-on-bacon (0.2.3)
|
|
149
137
|
mocha (>= 0.13.0)
|
|
150
138
|
molinillo (0.8.0)
|
|
151
|
-
multipart-post (2.2.3)
|
|
152
139
|
mustache (1.1.1)
|
|
153
140
|
nanaimo (0.3.0)
|
|
154
141
|
nap (1.1.0)
|
|
155
142
|
netrc (0.11.0)
|
|
156
143
|
no_proxy_fix (0.1.2)
|
|
157
|
-
octokit (
|
|
144
|
+
octokit (6.1.1)
|
|
158
145
|
faraday (>= 1, < 3)
|
|
159
146
|
sawyer (~> 0.9)
|
|
160
147
|
open4 (1.3.4)
|
|
161
|
-
parallel (1.
|
|
162
|
-
parser (3.
|
|
148
|
+
parallel (1.23.0)
|
|
149
|
+
parser (3.2.2.3)
|
|
163
150
|
ast (~> 2.4.1)
|
|
151
|
+
racc
|
|
164
152
|
prettybacon (0.0.2)
|
|
165
153
|
bacon (~> 1.2)
|
|
166
154
|
public_suffix (4.0.7)
|
|
155
|
+
racc (1.7.1)
|
|
167
156
|
rainbow (3.1.1)
|
|
168
157
|
rake (13.0.6)
|
|
169
158
|
rchardet (1.8.0)
|
|
170
|
-
redcarpet (3.
|
|
171
|
-
regexp_parser (2.
|
|
172
|
-
rexml (3.2.
|
|
173
|
-
rouge (
|
|
174
|
-
rubocop (1.
|
|
159
|
+
redcarpet (3.6.0)
|
|
160
|
+
regexp_parser (2.8.1)
|
|
161
|
+
rexml (3.2.6)
|
|
162
|
+
rouge (4.1.3)
|
|
163
|
+
rubocop (1.56.3)
|
|
164
|
+
base64 (~> 0.1.1)
|
|
175
165
|
json (~> 2.3)
|
|
166
|
+
language_server-protocol (>= 3.17.0)
|
|
176
167
|
parallel (~> 1.10)
|
|
177
|
-
parser (>= 3.
|
|
168
|
+
parser (>= 3.2.2.3)
|
|
178
169
|
rainbow (>= 2.2.2, < 4.0)
|
|
179
170
|
regexp_parser (>= 1.8, < 3.0)
|
|
180
171
|
rexml (>= 3.2.5, < 4.0)
|
|
181
|
-
rubocop-ast (>= 1.
|
|
172
|
+
rubocop-ast (>= 1.28.1, < 2.0)
|
|
182
173
|
ruby-progressbar (~> 1.7)
|
|
183
|
-
unicode-display_width (>=
|
|
184
|
-
rubocop-ast (1.
|
|
185
|
-
parser (>= 3.
|
|
174
|
+
unicode-display_width (>= 2.4.0, < 3.0)
|
|
175
|
+
rubocop-ast (1.29.0)
|
|
176
|
+
parser (>= 3.2.1.0)
|
|
186
177
|
ruby-macho (2.5.1)
|
|
187
|
-
ruby-progressbar (1.
|
|
178
|
+
ruby-progressbar (1.13.0)
|
|
188
179
|
ruby2_keywords (0.0.5)
|
|
189
180
|
sassc (2.4.0)
|
|
190
181
|
ffi (~> 1.9)
|
|
191
182
|
sawyer (0.9.2)
|
|
192
183
|
addressable (>= 2.3.5)
|
|
193
184
|
faraday (>= 0.17.3, < 3)
|
|
194
|
-
sqlite3 (1.
|
|
185
|
+
sqlite3 (1.6.6)
|
|
195
186
|
mini_portile2 (~> 2.8.0)
|
|
196
187
|
terminal-table (3.0.2)
|
|
197
188
|
unicode-display_width (>= 1.1.1, < 3)
|
|
198
189
|
typhoeus (1.4.0)
|
|
199
190
|
ethon (>= 0.9.0)
|
|
200
|
-
tzinfo (2.0.
|
|
191
|
+
tzinfo (2.0.6)
|
|
201
192
|
concurrent-ruby (~> 1.0)
|
|
202
|
-
unicode-display_width (2.2
|
|
203
|
-
webmock (3.
|
|
193
|
+
unicode-display_width (2.4.2)
|
|
194
|
+
webmock (3.19.1)
|
|
204
195
|
addressable (>= 2.8.0)
|
|
205
196
|
crack (>= 0.3.2)
|
|
206
197
|
hashdiff (>= 0.4.0, < 2.0.0)
|
|
@@ -213,7 +204,6 @@ GEM
|
|
|
213
204
|
colored2 (~> 3.1)
|
|
214
205
|
nanaimo (~> 0.3.0)
|
|
215
206
|
rexml (~> 3.2.4)
|
|
216
|
-
zeitwerk (2.6.0)
|
|
217
207
|
|
|
218
208
|
PLATFORMS
|
|
219
209
|
ruby
|
|
@@ -221,7 +211,7 @@ PLATFORMS
|
|
|
221
211
|
DEPENDENCIES
|
|
222
212
|
bacon
|
|
223
213
|
bundler (~> 2.1)
|
|
224
|
-
clintegracon
|
|
214
|
+
clintegracon!
|
|
225
215
|
danger
|
|
226
216
|
diffy
|
|
227
217
|
jazzy!
|
|
@@ -233,4 +223,4 @@ DEPENDENCIES
|
|
|
233
223
|
webmock
|
|
234
224
|
|
|
235
225
|
BUNDLED WITH
|
|
236
|
-
2.
|
|
226
|
+
2.3.26
|
data/README.md
CHANGED
|
@@ -214,16 +214,14 @@ sourcekitten doc --objc $(pwd)/MyProject/MyProject.h \
|
|
|
214
214
|
-I $(pwd) -fmodules > objcDoc.json
|
|
215
215
|
|
|
216
216
|
# Feed both outputs to Jazzy as a comma-separated list
|
|
217
|
-
jazzy --sourcekitten-sourcefile swiftDoc.json,objcDoc.json
|
|
217
|
+
jazzy --module MyProject --sourcekitten-sourcefile swiftDoc.json,objcDoc.json
|
|
218
218
|
```
|
|
219
219
|
|
|
220
220
|
### Docs from `.swiftmodule`s or frameworks
|
|
221
221
|
|
|
222
|
-
*This feature is new
|
|
223
|
-
and mistakes: reports welcome.*
|
|
222
|
+
*This feature is new: there may be crashes and mistakes. Reports welcome.*
|
|
224
223
|
|
|
225
|
-
Swift 5.3
|
|
226
|
-
This looks to be part of Apple's toolchain for generating their online docs.
|
|
224
|
+
Swift 5.3 added support for symbol graph generation from `.swiftmodule` files.
|
|
227
225
|
|
|
228
226
|
Jazzy can use this to generate API documentation. This is faster than using
|
|
229
227
|
the source code directly but does have limitations: for example documentation
|
|
@@ -360,25 +358,69 @@ Note that the `--include` option is applied before the `--exclude` option. For e
|
|
|
360
358
|
Declarations with a documentation comment containing `:nodoc:` are excluded from the
|
|
361
359
|
documentation.
|
|
362
360
|
|
|
361
|
+
Declarations with the `@_documentation(visibility:)` attribute are treated as though they
|
|
362
|
+
are written with the given visibility. You can use this as a replacement for `:nodoc:` as
|
|
363
|
+
part of a transition to Apple's DocC but it is not compatible with Jazzy's symbolgraph mode.
|
|
364
|
+
|
|
363
365
|
### Documentation structure
|
|
364
366
|
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
367
|
+
Jazzy arranges documentation into categories. The default categories are things
|
|
368
|
+
like _Classes_ and _Structures_ corresponding to programming-language concepts,
|
|
369
|
+
as well as _Guides_ if `--documentation` is set.
|
|
370
|
+
|
|
371
|
+
You can customize the categories and their contents using `custom_categories` in
|
|
372
|
+
the config file — see the ReSwift [docs](https://reswift.github.io/ReSwift/) and
|
|
373
|
+
[config file](https://github.com/ReSwift/ReSwift/blob/e94737282850fa038b625b4e351d1608a3d02cee/.jazzy.json)
|
|
374
|
+
for an example.
|
|
375
|
+
|
|
376
|
+
Within each category the items are ordered first alphabetically by source
|
|
377
|
+
filename, and then by declaration order within the file. You can use
|
|
378
|
+
`// MARK:` comments within the file to create subheadings on the page, for
|
|
379
|
+
example to split up properties and methods. There’s no way to customize this
|
|
380
|
+
order short of editing either the generated web page or the SourceKitten JSON.
|
|
381
|
+
|
|
382
|
+
Swift extensions and Objective-C categories allow type members to be declared
|
|
383
|
+
across multiple source files. In general, extensions follow the main type
|
|
384
|
+
declaration: first extensions from the same source file, then extensions from
|
|
385
|
+
other files ordered alphabetically by filename. Swift conditional extensions
|
|
386
|
+
(`extension A where …`) always appear beneath unconditional extensions.
|
|
387
|
+
|
|
388
|
+
Use this pattern to add or customize the subheading before extension members:
|
|
389
|
+
```swift
|
|
390
|
+
extension MyType {
|
|
391
|
+
// MARK: Subheading for this group of methods
|
|
392
|
+
…
|
|
393
|
+
}
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
When Jazzy is using `--swift-build-tool symgraph` the source file names and
|
|
397
|
+
line numbers may not be available. In this case the ordering is approximately
|
|
398
|
+
alphabetical by symbol name and USR; the order is stable for the same input.
|
|
399
|
+
|
|
400
|
+
Jazzy does not normally create separate web pages for declarations that do not
|
|
401
|
+
have any members -- instead they are entirely nested into their parent page. Use
|
|
402
|
+
the `--separate-global-declarations` flag to change this and create pages for
|
|
403
|
+
these empty types.
|
|
369
404
|
|
|
370
405
|
### Choosing the Swift language version
|
|
371
406
|
|
|
372
407
|
Jazzy normally uses the Swift compiler from the Xcode currently configured by
|
|
373
|
-
`xcode-select`. Use the `--swift-version` flag
|
|
374
|
-
Xcode.
|
|
408
|
+
`xcode-select`. Use the `--swift-version` flag or the `DEVELOPER_DIR` environment
|
|
409
|
+
variable to compile with a different Xcode.
|
|
375
410
|
|
|
376
411
|
The value you pass to `--swift-version` must be the Swift language version given
|
|
377
|
-
by `swift --version` in the Xcode you want to use.
|
|
412
|
+
by `swift --version` in the Xcode you want to use. Jazzy uses
|
|
413
|
+
[xcinvoke](https://github.com/segiddins/xcinvoke) to find a suitable Xcode
|
|
414
|
+
installation on your system. This can be slow: if you know where Xcode is
|
|
415
|
+
installed then it's faster to set `DEVELOPER_DIR` directly.
|
|
378
416
|
|
|
379
|
-
For example to use Xcode
|
|
417
|
+
For example to use Xcode 14:
|
|
380
418
|
```shell
|
|
381
|
-
jazzy --swift-version
|
|
419
|
+
jazzy --swift-version 5.7
|
|
420
|
+
```
|
|
421
|
+
...or:
|
|
422
|
+
```shell
|
|
423
|
+
DEVELOPER_DIR=/Applications/Xcode_14.app/Contents/Developer jazzy
|
|
382
424
|
```
|
|
383
425
|
|
|
384
426
|
## Linux
|
|
@@ -423,6 +465,36 @@ Check the `--min-acl` setting -- see [above](#controlling-what-is-documented).
|
|
|
423
465
|
|
|
424
466
|
See [this document](ObjectiveC.md).
|
|
425
467
|
|
|
468
|
+
### Miscellaneous
|
|
469
|
+
|
|
470
|
+
**Missing docset**
|
|
471
|
+
|
|
472
|
+
Jazzy only builds a docset when you set the `--module` flag.
|
|
473
|
+
|
|
474
|
+
**Unable to pass --build-tool-arguments containing commas**
|
|
475
|
+
|
|
476
|
+
If you want Jazzy to run something like `xcodebuild -scheme Scheme -destination 'a=x,b=y,c=z'`
|
|
477
|
+
then you must use the config file instead of the CLI flag because the CLI parser
|
|
478
|
+
that Jazzy uses cannot handle arguments that themselves contain commas.
|
|
479
|
+
|
|
480
|
+
The example config file here would be:
|
|
481
|
+
```yaml
|
|
482
|
+
build_tool_arguments:
|
|
483
|
+
- "-scheme"
|
|
484
|
+
- "Scheme"
|
|
485
|
+
- "-destination"
|
|
486
|
+
- "a=x,b=y,c=z"
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
**Errors running in an Xcode Run Script phase**
|
|
490
|
+
|
|
491
|
+
Running Jazzy from an Xcode build phase can go wrong in cryptic ways when Jazzy
|
|
492
|
+
has to run `xcodebuild`.
|
|
493
|
+
|
|
494
|
+
Users [have reported](https://github.com/realm/jazzy/issues/1012) that error
|
|
495
|
+
messages about symbols lacking USRs can be fixed by unsetting
|
|
496
|
+
`LLVM_TARGET_TRIPLE_SUFFIX` as part of the run script.
|
|
497
|
+
|
|
426
498
|
### Installation Problems
|
|
427
499
|
|
|
428
500
|
**Can't find header files / clang**
|
data/Rakefile
CHANGED