jazzy 0.7.2 → 0.7.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +45 -0
  3. data/CONTRIBUTING.md +6 -0
  4. data/Dangerfile +6 -6
  5. data/Gemfile +1 -1
  6. data/Gemfile.lock +66 -46
  7. data/README.md +12 -12
  8. data/images/logo.jpg +0 -0
  9. data/images/logo.sketch +0 -0
  10. data/{realm.png → images/realm.png} +0 -0
  11. data/{screenshot.jpg → images/screenshot.jpg} +0 -0
  12. data/jazzy.gemspec +1 -1
  13. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework +0 -0
  14. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant +0 -0
  15. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Commandant +0 -0
  16. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist +7 -7
  17. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result +0 -0
  18. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist +7 -7
  19. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Result +0 -0
  20. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash +0 -0
  21. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist +7 -7
  22. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash +0 -0
  23. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/{Yaml.framework → Yams.framework}/Versions/A/Resources/Info.plist +11 -11
  24. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams +0 -0
  25. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams +0 -0
  26. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib +0 -0
  27. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib +0 -0
  28. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib +0 -0
  29. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDispatch.dylib +0 -0
  30. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftFoundation.dylib +0 -0
  31. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftIOKit.dylib +0 -0
  32. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib +0 -0
  33. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist +7 -7
  34. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/SourceKittenFramework +0 -0
  35. data/lib/jazzy/SourceKitten/bin/sourcekitten +0 -0
  36. data/lib/jazzy/doc_builder.rb +3 -2
  37. data/lib/jazzy/gem_version.rb +1 -1
  38. data/lib/jazzy/podspec_documenter.rb +12 -4
  39. data/lib/jazzy/source_declaration/type.rb +1 -1
  40. metadata +11 -11
  41. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yaml.framework/Versions/A/Yaml +0 -0
  42. data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yaml.framework/Yaml +0 -0
  43. data/logo.jpg +0 -0
  44. data/logo.sketch +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d5fffd12cb7f8be3f0c8324d58223c473d448f08
4
- data.tar.gz: 6d0f919efaff11797da75225f4f2b0e4c5b1465a
3
+ metadata.gz: 1ffd1283d3e9554b3129dae997e56f6e3a7772e1
4
+ data.tar.gz: 8f3bc13009bdf3c7f2ddc8d71809b33507eaceb4
5
5
  SHA512:
6
- metadata.gz: 3042eece94b7af43d07cb2282c5571a78729566bc6b42ef4abce1aad65fc58d3345b8067007ec4ac2dd08cea24fc27a67ffe53b11a893a3f5597a389535f06f7
7
- data.tar.gz: dc9e5769d1f755f176e7d9bd7600fa1f2a12f679ecd4c4c9ef77db7c15dcba7970ca3ceb7b064e827438c20e4baa5fabedeb69aa6e733e35ea38f64f2c922e0e
6
+ metadata.gz: 0c0f29323eba5d303f45a48ae40e9191907e72b6df3cbd8890960571b3914bd2b31f3cfed623bc5d4cbec258601e197fdc241850026026062b5695ca75c8c04c
7
+ data.tar.gz: 1c104f4b91a35bede65f55e596f93f3317fef2cda6e6eb842b0b55f2ef1eb60a2ca8fa353267f817e6ddbbf589ec0d8666c1e84eb17c6b3068de0e9fd430b8eb
@@ -1,3 +1,48 @@
1
+ ## 0.7.3
2
+
3
+ ##### Breaking
4
+
5
+ * None.
6
+
7
+ ##### Enhancements
8
+
9
+ * Podspec-based documentation will take trunk's `pushed_with_swift_version`
10
+ attribute into account when generating documentation by default.
11
+ [Orta Therox](https://github.com/orta)
12
+
13
+ * Podspec-based documentation respects the `swift-version` config option.
14
+ [Orta Therox](https://github.com/orta)
15
+
16
+ ##### Enhancements
17
+
18
+ * Support Objective-C class properties.
19
+ [Jérémie Girault](https://github.com/jeremiegirault)
20
+ [JP Simard](https://github.com/jpsim)
21
+
22
+ * Support documenting Swift 3 operator precedence groups.
23
+ [JP Simard](https://github.com/jpsim)
24
+
25
+ ##### Bug Fixes
26
+
27
+ * Rename Dash typedef type from "Alias" to "Type".
28
+ [Bogdan Popescu](https://github.com/Kapeli)
29
+
30
+ * Fix crash when sorting multiple identically named declarations with no USR,
31
+ which is very common when generating docs for podspecs supporting multiple
32
+ platforms.
33
+ [JP Simard](https://github.com/jpsim)
34
+ [#661](https://github.com/realm/jazzy/issues/661)
35
+
36
+ * Fix Xcode not being found when specifying a custom Swift version
37
+ (`--swift-version`).
38
+ [Samuel Giddins](https://github.com/segiddins)
39
+ [Paul Cantrell](https://github.com/pcantrell)
40
+ [#656](https://github.com/realm/jazzy/issues/656)
41
+
42
+ * Fix crash when generating Objective-C docs for projects with "@" directives in
43
+ documentation comments with Xcode 8.1 or later.
44
+ [Jérémie Girault](https://github.com/jeremiegirault)
45
+
1
46
  ## 0.7.2
2
47
 
3
48
  ##### Breaking
@@ -1,3 +1,9 @@
1
+ ## Code of Conduct
2
+
3
+ This project adheres to the [Contributor Covenant Code of Conduct](https://realm.io/conduct).
4
+ By participating, you are expected to uphold this code. Please report
5
+ unacceptable behavior to [info@realm.io](mailto:info@realm.io).
6
+
1
7
  ## Tracking changes
2
8
 
3
9
  All changes should be made via pull requests on GitHub.
data/Dangerfile CHANGED
@@ -1,8 +1,8 @@
1
1
  # Warn when there is a big PR
2
- warn("Big PR") if lines_of_code > 500
2
+ warn("Big PR") if git.lines_of_code > 500
3
3
 
4
4
  # Don't let testing shortcuts get into master by accident
5
- (modified_files + added_files - %w(Dangerfile)).each do |file|
5
+ (git.modified_files + git.added_files - %w(Dangerfile)).each do |file|
6
6
  next unless File.file?(file)
7
7
  contents = File.read(file)
8
8
  if file.start_with?('spec')
@@ -13,16 +13,16 @@ end
13
13
 
14
14
  # Sometimes its a README fix, or something like that - which isn't relevant for
15
15
  # including in a CHANGELOG for example
16
- has_app_changes = !modified_files.grep(/lib/).empty?
17
- has_test_changes = !modified_files.grep(/spec/).empty?
16
+ has_app_changes = !git.modified_files.grep(/lib/).empty?
17
+ has_test_changes = !git.modified_files.grep(/spec/).empty?
18
18
 
19
19
  # Add a CHANGELOG entry for app changes
20
- if !modified_files.include?("CHANGELOG.md") && has_app_changes
20
+ if !git.modified_files.include?("CHANGELOG.md") && has_app_changes
21
21
  fail("Please include a CHANGELOG entry. \nYou can find it at [CHANGELOG.md](https://github.com/realm/jazzy/blob/master/CHANGELOG.md).")
22
22
  message "Note, we hard-wrap at 80 chars and use 2 spaces after the last line."
23
23
  end
24
24
 
25
25
  # Non-trivial amounts of app changes without tests
26
- if lines_of_code > 50 && has_app_changes && !has_test_changes
26
+ if git.lines_of_code > 50 && has_app_changes && !has_test_changes
27
27
  warn "This PR may need tests."
28
28
  end
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
- source 'http://rubygems.org'
1
+ source 'https://rubygems.org'
2
2
 
3
3
  gemspec
4
4
 
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- jazzy (0.7.2)
4
+ jazzy (0.7.3)
5
5
  cocoapods (~> 1.0)
6
6
  mustache (~> 0.99)
7
7
  open4
@@ -9,100 +9,118 @@ PATH
9
9
  rouge (~> 1.5)
10
10
  sass (~> 3.4)
11
11
  sqlite3 (~> 1.3)
12
- xcinvoke (~> 0.2.1)
12
+ xcinvoke (~> 0.3.0)
13
13
 
14
14
  GEM
15
- remote: http://rubygems.org/
15
+ remote: https://rubygems.org/
16
16
  specs:
17
- activesupport (4.2.6)
17
+ CFPropertyList (2.3.4)
18
+ activesupport (4.2.7.1)
18
19
  i18n (~> 0.7)
19
20
  json (~> 1.7, >= 1.7.7)
20
21
  minitest (~> 5.1)
21
22
  thread_safe (~> 0.3, >= 0.3.4)
22
23
  tzinfo (~> 1.1)
23
- addressable (2.4.0)
24
+ addressable (2.5.0)
25
+ public_suffix (~> 2.0, >= 2.0.2)
24
26
  ast (2.2.0)
25
27
  bacon (1.2.0)
26
- claide (1.0.0)
28
+ claide (1.0.1)
29
+ claide-plugins (0.9.2)
30
+ cork
31
+ nap
32
+ open4 (~> 1.3)
27
33
  clintegracon (0.7.0)
28
34
  colored (~> 1.2)
29
35
  diffy
30
- cocoapods (1.0.1)
31
- activesupport (>= 4.0.2)
32
- claide (>= 1.0.0, < 2.0)
33
- cocoapods-core (= 1.0.1)
34
- cocoapods-deintegrate (>= 1.0.0, < 2.0)
35
- cocoapods-downloader (>= 1.0.0, < 2.0)
36
+ cocoapods (1.1.1)
37
+ activesupport (>= 4.0.2, < 5)
38
+ claide (>= 1.0.1, < 2.0)
39
+ cocoapods-core (= 1.1.1)
40
+ cocoapods-deintegrate (>= 1.0.1, < 2.0)
41
+ cocoapods-downloader (>= 1.1.2, < 2.0)
36
42
  cocoapods-plugins (>= 1.0.0, < 2.0)
37
43
  cocoapods-search (>= 1.0.0, < 2.0)
38
44
  cocoapods-stats (>= 1.0.0, < 2.0)
39
- cocoapods-trunk (>= 1.0.0, < 2.0)
40
- cocoapods-try (>= 1.0.0, < 2.0)
45
+ cocoapods-trunk (>= 1.1.1, < 2.0)
46
+ cocoapods-try (>= 1.1.0, < 2.0)
41
47
  colored (~> 1.2)
42
48
  escape (~> 0.0.4)
43
- fourflusher (~> 0.3.0)
44
- molinillo (~> 0.4.5)
49
+ fourflusher (~> 2.0.1)
50
+ gh_inspector (~> 1.0)
51
+ molinillo (~> 0.5.1)
45
52
  nap (~> 1.0)
46
- xcodeproj (>= 1.1.0, < 2.0)
47
- cocoapods-core (1.0.1)
48
- activesupport (>= 4.0.2)
53
+ xcodeproj (>= 1.3.3, < 2.0)
54
+ cocoapods-core (1.1.1)
55
+ activesupport (>= 4.0.2, < 5)
49
56
  fuzzy_match (~> 2.0.4)
50
57
  nap (~> 1.0)
51
- cocoapods-deintegrate (1.0.0)
52
- cocoapods-downloader (1.0.0)
58
+ cocoapods-deintegrate (1.0.1)
59
+ cocoapods-downloader (1.1.2)
53
60
  cocoapods-plugins (1.0.0)
54
61
  nap
55
62
  cocoapods-search (1.0.0)
56
63
  cocoapods-stats (1.0.0)
57
- cocoapods-trunk (1.0.0)
64
+ cocoapods-trunk (1.1.1)
58
65
  nap (>= 0.8, < 2.0)
59
66
  netrc (= 0.7.8)
60
- cocoapods-try (1.0.0)
67
+ cocoapods-try (1.1.0)
61
68
  colored (1.2)
69
+ cork (0.2.0)
70
+ colored (~> 1.2)
62
71
  crack (0.4.3)
63
72
  safe_yaml (~> 1.0.0)
64
- danger (0.8.1)
65
- claide
73
+ danger (4.0.1)
74
+ claide (~> 1.0)
75
+ claide-plugins (>= 0.9.2)
66
76
  colored (~> 1.2)
67
- faraday
68
- git
77
+ cork (~> 0.1)
78
+ faraday (~> 0.9)
79
+ faraday-http-cache (~> 1.0)
80
+ git (~> 1)
81
+ kramdown (~> 1.5)
69
82
  octokit (~> 4.2)
70
- redcarpet (~> 3.3)
71
83
  terminal-table (~> 1)
72
84
  diffy (3.1.0)
73
85
  escape (0.0.4)
74
- faraday (0.9.2)
86
+ faraday (0.10.0)
75
87
  multipart-post (>= 1.2, < 3)
76
- fourflusher (0.3.1)
88
+ faraday-http-cache (1.3.1)
89
+ faraday (~> 0.8)
90
+ fourflusher (2.0.1)
77
91
  fuzzy_match (2.0.4)
92
+ gh_inspector (1.0.2)
78
93
  git (1.3.0)
79
94
  hashdiff (0.3.0)
80
95
  i18n (0.7.0)
81
96
  json (1.8.3)
82
- liferaft (0.0.4)
97
+ kramdown (1.13.1)
98
+ liferaft (0.0.6)
83
99
  metaclass (0.0.4)
84
- minitest (5.9.0)
100
+ minitest (5.10.0)
85
101
  mocha (1.1.0)
86
102
  metaclass (~> 0.0.1)
87
103
  mocha-on-bacon (0.2.2)
88
104
  mocha (>= 0.13.0)
89
- molinillo (0.4.5)
105
+ molinillo (0.5.4)
90
106
  multipart-post (2.0.0)
91
107
  mustache (0.99.8)
108
+ nanaimo (0.2.3)
92
109
  nap (1.1.0)
93
110
  netrc (0.7.8)
94
- octokit (4.3.0)
95
- sawyer (~> 0.7.0, >= 0.5.3)
111
+ octokit (4.6.2)
112
+ sawyer (~> 0.8.0, >= 0.5.3)
96
113
  open4 (1.3.4)
97
114
  parser (2.3.0.7)
98
115
  ast (~> 2.2)
99
116
  powerpack (0.1.1)
100
117
  prettybacon (0.0.2)
101
118
  bacon (~> 1.2)
119
+ public_suffix (2.0.4)
102
120
  rainbow (2.1.0)
103
121
  rake (10.5.0)
104
122
  redcarpet (3.3.4)
105
- rouge (1.11.0)
123
+ rouge (1.11.1)
106
124
  rubocop (0.39.0)
107
125
  parser (>= 2.3.0.7, < 3.0)
108
126
  powerpack (~> 0.1)
@@ -112,11 +130,11 @@ GEM
112
130
  ruby-progressbar (1.7.5)
113
131
  safe_yaml (1.0.4)
114
132
  sass (3.4.22)
115
- sawyer (0.7.0)
116
- addressable (>= 2.3.5, < 2.5)
117
- faraday (~> 0.8, < 0.10)
118
- sqlite3 (1.3.11)
119
- terminal-table (1.5.2)
133
+ sawyer (0.8.1)
134
+ addressable (>= 2.3.5, < 2.6)
135
+ faraday (~> 0.8, < 1.0)
136
+ sqlite3 (1.3.12)
137
+ terminal-table (1.6.0)
120
138
  thread_safe (0.3.5)
121
139
  tzinfo (1.2.2)
122
140
  thread_safe (~> 0.1)
@@ -125,12 +143,14 @@ GEM
125
143
  addressable (>= 2.3.6)
126
144
  crack (>= 0.3.2)
127
145
  hashdiff
128
- xcinvoke (0.2.1)
129
- liferaft (~> 0.0.4)
130
- xcodeproj (1.1.0)
146
+ xcinvoke (0.3.0)
147
+ liferaft (~> 0.0.6)
148
+ xcodeproj (1.4.1)
149
+ CFPropertyList (~> 2.3.3)
131
150
  activesupport (>= 3)
132
- claide (>= 1.0.0, < 2.0)
151
+ claide (>= 1.0.1, < 2.0)
133
152
  colored (~> 1.2)
153
+ nanaimo (~> 0.2.0)
134
154
 
135
155
  PLATFORMS
136
156
  ruby
@@ -150,4 +170,4 @@ DEPENDENCIES
150
170
  webmock
151
171
 
152
172
  BUNDLED WITH
153
- 1.12.5
173
+ 1.13.6
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
- ![jazzy](logo.jpg)
1
+ ![jazzy](images/logo.jpg)
2
2
 
3
3
  ![analytics](https://ga-beacon.appspot.com/UA-50247013-2/jazzy/README?pixel)
4
4
 
5
- ![Test Status](https://travis-ci.org/realm/jazzy.svg?branch=master)
5
+ [![Build Status](https://travis-ci.org/realm/jazzy.svg?branch=master)](https://travis-ci.org/realm/jazzy)
6
6
 
7
7
  *jazzy is a command-line utility that generates documentation for Swift or Objective-C*
8
8
 
@@ -14,10 +14,10 @@ Both Swift and Objective-C projects are supported.
14
14
 
15
15
  Instead of parsing your source files, `jazzy` hooks into [Clang][clang] and
16
16
  [SourceKit][sourcekit] to use the [AST][ast] representation of your code and
17
- its comments for more accurate results. The output matches the look and feel
17
+ its comments for more accurate results. The output matches the look and feel
18
18
  of Apple’s official reference documentation, post WWDC 2014.
19
19
 
20
- ![Screenshot](screenshot.jpg)
20
+ ![Screenshot](images/screenshot.jpg)
21
21
 
22
22
  This project adheres to the [Contributor Covenant Code of Conduct](https://realm.io/conduct).
23
23
  By participating, you are expected to uphold this code. Please report
@@ -25,7 +25,7 @@ unacceptable behavior to [info@realm.io](mailto:info@realm.io).
25
25
 
26
26
  ## Requirements
27
27
 
28
- * A version of [Xcode][xcode] (6.x or 7.x) capable of building the project
28
+ * A version of [Xcode][xcode] (6.x or 7.x) capable of building the project
29
29
  you wish to document. It must be installed in a location indexed by Spotlight.
30
30
 
31
31
  ## Installation
@@ -58,7 +58,7 @@ is slightly different. In Swift you would write `- returns:`, but in Objective-C
58
58
 
59
59
  Swift documentation is generated by default.
60
60
 
61
- ##### Example
61
+ ##### Example
62
62
 
63
63
  This is how Realm Swift docs are generated:
64
64
 
@@ -83,7 +83,7 @@ To generate documentation for Objective-C headers, you must pass the following
83
83
  parameters to jazzy:
84
84
 
85
85
  * `--objc`
86
- * `--umbrella-header ...`
86
+ * `--umbrella-header ...`
87
87
  * `-framework-root ...`
88
88
  * `--sdk [iphone|watch|appletv][os|simulator]|macosx` (optional, default value
89
89
  of `macosx`)
@@ -184,15 +184,15 @@ set the `--min-acl` flag to `internal` or `private`.
184
184
 
185
185
  Please review jazzy's [contributing guidelines](https://github.com/realm/jazzy/blob/master/CONTRIBUTING.md) when submitting pull requests.
186
186
 
187
- jazzy is composed of two parts:
187
+ jazzy is composed of two parts:
188
188
 
189
189
  1. The parser, [SourceKitten][SourceKitten] (written in Swift)
190
190
  2. The site generator (written in ruby)
191
191
 
192
- To build and run jazzy from source:
192
+ To build and run jazzy from source:
193
193
 
194
- 1. Install [bundler][bundler].
195
- 2. Run `bundle install` from the root of this repo.
194
+ 1. Install [bundler][bundler].
195
+ 2. Run `bundle install` from the root of this repo.
196
196
  3. Run jazzy from source by running `bin/jazzy`.
197
197
 
198
198
  Instructions to build SourceKitten from source can be found at
@@ -213,7 +213,7 @@ This project is released under the [MIT license](https://github.com/realm/jazzy/
213
213
 
214
214
  ## About
215
215
 
216
- <img src="realm.png" width="184" />
216
+ <img src="images/realm.png" width="184" />
217
217
 
218
218
  Jazzy is maintained and funded by Realm Inc. The names and logos for
219
219
  Realm are trademarks of Realm Inc.
Binary file
Binary file
File without changes
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
26
26
  spec.add_runtime_dependency 'rouge', '~> 1.5'
27
27
  spec.add_runtime_dependency 'sass', '~> 3.4'
28
28
  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
29
- spec.add_runtime_dependency 'xcinvoke', '~> 0.2.1'
29
+ spec.add_runtime_dependency 'xcinvoke', '~> 0.3.0'
30
30
 
31
31
  spec.add_development_dependency 'bundler', '~> 1.7'
32
32
  spec.add_development_dependency 'rake', '~> 10.3'
@@ -3,7 +3,7 @@
3
3
  <plist version="1.0">
4
4
  <dict>
5
5
  <key>BuildMachineOSBuild</key>
6
- <string>15G7a</string>
6
+ <string>16C53a</string>
7
7
  <key>CFBundleDevelopmentRegion</key>
8
8
  <string>en</string>
9
9
  <key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
17
17
  <key>CFBundlePackageType</key>
18
18
  <string>FMWK</string>
19
19
  <key>CFBundleShortVersionString</key>
20
- <string>0.9.0</string>
20
+ <string>0.11.3</string>
21
21
  <key>CFBundleSignature</key>
22
22
  <string>????</string>
23
23
  <key>CFBundleSupportedPlatforms</key>
@@ -29,17 +29,17 @@
29
29
  <key>DTCompiler</key>
30
30
  <string>com.apple.compilers.llvm.clang.1_0</string>
31
31
  <key>DTPlatformBuild</key>
32
- <string>7D1014</string>
32
+ <string>8B62</string>
33
33
  <key>DTPlatformVersion</key>
34
34
  <string>GM</string>
35
35
  <key>DTSDKBuild</key>
36
- <string>15E60</string>
36
+ <string>16B2649</string>
37
37
  <key>DTSDKName</key>
38
- <string>macosx10.11</string>
38
+ <string>macosx10.12</string>
39
39
  <key>DTXcode</key>
40
- <string>0731</string>
40
+ <string>0810</string>
41
41
  <key>DTXcodeBuild</key>
42
- <string>7D1014</string>
42
+ <string>8B62</string>
43
43
  <key>NSHumanReadableCopyright</key>
44
44
  <string>Copyright © 2014 Carthage. All rights reserved.</string>
45
45
  </dict>
@@ -3,7 +3,7 @@
3
3
  <plist version="1.0">
4
4
  <dict>
5
5
  <key>BuildMachineOSBuild</key>
6
- <string>15G7a</string>
6
+ <string>16C53a</string>
7
7
  <key>CFBundleDevelopmentRegion</key>
8
8
  <string>en</string>
9
9
  <key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
17
17
  <key>CFBundlePackageType</key>
18
18
  <string>FMWK</string>
19
19
  <key>CFBundleShortVersionString</key>
20
- <string>1.0.2</string>
20
+ <string>3.1.0</string>
21
21
  <key>CFBundleSignature</key>
22
22
  <string>????</string>
23
23
  <key>CFBundleSupportedPlatforms</key>
@@ -29,17 +29,17 @@
29
29
  <key>DTCompiler</key>
30
30
  <string>com.apple.compilers.llvm.clang.1_0</string>
31
31
  <key>DTPlatformBuild</key>
32
- <string>7D1014</string>
32
+ <string>8B62</string>
33
33
  <key>DTPlatformVersion</key>
34
34
  <string>GM</string>
35
35
  <key>DTSDKBuild</key>
36
- <string>15E60</string>
36
+ <string>16B2649</string>
37
37
  <key>DTSDKName</key>
38
- <string>macosx10.11</string>
38
+ <string>macosx10.12</string>
39
39
  <key>DTXcode</key>
40
- <string>0731</string>
40
+ <string>0810</string>
41
41
  <key>DTXcodeBuild</key>
42
- <string>7D1014</string>
42
+ <string>8B62</string>
43
43
  <key>NSHumanReadableCopyright</key>
44
44
  <string>Copyright © 2015 Rob Rix. All rights reserved.</string>
45
45
  </dict>
@@ -3,7 +3,7 @@
3
3
  <plist version="1.0">
4
4
  <dict>
5
5
  <key>BuildMachineOSBuild</key>
6
- <string>15G7a</string>
6
+ <string>16C53a</string>
7
7
  <key>CFBundleDevelopmentRegion</key>
8
8
  <string>en</string>
9
9
  <key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
17
17
  <key>CFBundlePackageType</key>
18
18
  <string>FMWK</string>
19
19
  <key>CFBundleShortVersionString</key>
20
- <string>1.0</string>
20
+ <string>2.0</string>
21
21
  <key>CFBundleSignature</key>
22
22
  <string>????</string>
23
23
  <key>CFBundleSupportedPlatforms</key>
@@ -29,17 +29,17 @@
29
29
  <key>DTCompiler</key>
30
30
  <string>com.apple.compilers.llvm.clang.1_0</string>
31
31
  <key>DTPlatformBuild</key>
32
- <string>7D1014</string>
32
+ <string>8B62</string>
33
33
  <key>DTPlatformVersion</key>
34
34
  <string>GM</string>
35
35
  <key>DTSDKBuild</key>
36
- <string>15E60</string>
36
+ <string>16B2649</string>
37
37
  <key>DTSDKName</key>
38
- <string>macosx10.11</string>
38
+ <string>macosx10.12</string>
39
39
  <key>DTXcode</key>
40
- <string>0731</string>
40
+ <string>0810</string>
41
41
  <key>DTXcodeBuild</key>
42
- <string>7D1014</string>
42
+ <string>8B62</string>
43
43
  <key>UIDeviceFamily</key>
44
44
  <array>
45
45
  <integer>1</integer>
@@ -3,21 +3,21 @@
3
3
  <plist version="1.0">
4
4
  <dict>
5
5
  <key>BuildMachineOSBuild</key>
6
- <string>15G7a</string>
6
+ <string>16C53a</string>
7
7
  <key>CFBundleDevelopmentRegion</key>
8
8
  <string>en</string>
9
9
  <key>CFBundleExecutable</key>
10
- <string>Yaml</string>
10
+ <string>Yams</string>
11
11
  <key>CFBundleIdentifier</key>
12
- <string>behrang.Yaml</string>
12
+ <string>Yams</string>
13
13
  <key>CFBundleInfoDictionaryVersion</key>
14
14
  <string>6.0</string>
15
15
  <key>CFBundleName</key>
16
- <string>Yaml</string>
16
+ <string>Yams</string>
17
17
  <key>CFBundlePackageType</key>
18
18
  <string>FMWK</string>
19
19
  <key>CFBundleShortVersionString</key>
20
- <string>1.0</string>
20
+ <string>0.1.2</string>
21
21
  <key>CFBundleSignature</key>
22
22
  <string>????</string>
23
23
  <key>CFBundleSupportedPlatforms</key>
@@ -25,20 +25,20 @@
25
25
  <string>MacOSX</string>
26
26
  </array>
27
27
  <key>CFBundleVersion</key>
28
- <string>1</string>
28
+ <string></string>
29
29
  <key>DTCompiler</key>
30
30
  <string>com.apple.compilers.llvm.clang.1_0</string>
31
31
  <key>DTPlatformBuild</key>
32
- <string>7D1014</string>
32
+ <string>8B62</string>
33
33
  <key>DTPlatformVersion</key>
34
34
  <string>GM</string>
35
35
  <key>DTSDKBuild</key>
36
- <string>15E60</string>
36
+ <string>16B2649</string>
37
37
  <key>DTSDKName</key>
38
- <string>macosx10.11</string>
38
+ <string>macosx10.12</string>
39
39
  <key>DTXcode</key>
40
- <string>0731</string>
40
+ <string>0810</string>
41
41
  <key>DTXcodeBuild</key>
42
- <string>7D1014</string>
42
+ <string>8B62</string>
43
43
  </dict>
44
44
  </plist>
@@ -3,7 +3,7 @@
3
3
  <plist version="1.0">
4
4
  <dict>
5
5
  <key>BuildMachineOSBuild</key>
6
- <string>15G7a</string>
6
+ <string>16C53a</string>
7
7
  <key>CFBundleDevelopmentRegion</key>
8
8
  <string>en</string>
9
9
  <key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
17
17
  <key>CFBundlePackageType</key>
18
18
  <string>FMWK</string>
19
19
  <key>CFBundleShortVersionString</key>
20
- <string>0.13.0</string>
20
+ <string>0.15.2</string>
21
21
  <key>CFBundleSignature</key>
22
22
  <string>????</string>
23
23
  <key>CFBundleSupportedPlatforms</key>
@@ -29,17 +29,17 @@
29
29
  <key>DTCompiler</key>
30
30
  <string>com.apple.compilers.llvm.clang.1_0</string>
31
31
  <key>DTPlatformBuild</key>
32
- <string>7D1014</string>
32
+ <string>8B62</string>
33
33
  <key>DTPlatformVersion</key>
34
34
  <string>GM</string>
35
35
  <key>DTSDKBuild</key>
36
- <string>15E60</string>
36
+ <string>16B2649</string>
37
37
  <key>DTSDKName</key>
38
- <string>macosx10.11</string>
38
+ <string>macosx10.12</string>
39
39
  <key>DTXcode</key>
40
- <string>0731</string>
40
+ <string>0810</string>
41
41
  <key>DTXcodeBuild</key>
42
- <string>7D1014</string>
42
+ <string>8B62</string>
43
43
  <key>NSHumanReadableCopyright</key>
44
44
  <string>Copyright © 2015 SourceKitten. All rights reserved.</string>
45
45
  </dict>
@@ -32,7 +32,7 @@ module Jazzy
32
32
  def self.doc_structure_for_docs(docs)
33
33
  docs.map do |doc|
34
34
  children = doc.children
35
- .sort_by { |c| [c.nav_order, c.name, c.usr] }
35
+ .sort_by { |c| [c.nav_order, c.name, c.usr || ''] }
36
36
  .flat_map do |child|
37
37
  # FIXME: include arbitrarily nested extensible types
38
38
  [{ name: child.name, url: child.url }] +
@@ -57,7 +57,8 @@ module Jazzy
57
57
  stdout = options.sourcekitten_sourcefile.read
58
58
  else
59
59
  if options.podspec_configured
60
- stdout = PodspecDocumenter.new(options.podspec).sourcekitten_output
60
+ pod_documenter = PodspecDocumenter.new(options.podspec)
61
+ stdout = pod_documenter.sourcekitten_output(options)
61
62
  else
62
63
  stdout = Dir.chdir(options.source_directory) do
63
64
  arguments = SourceKitten.arguments_from_options(options)
@@ -1,3 +1,3 @@
1
1
  module Jazzy
2
- VERSION = '0.7.2'.freeze unless defined? Jazzy::VERSION
2
+ VERSION = '0.7.3'.freeze unless defined? Jazzy::VERSION
3
3
  end
@@ -9,7 +9,9 @@ module Jazzy
9
9
  @podspec = podspec
10
10
  end
11
11
 
12
- def sourcekitten_output
12
+ # Build documentation from the given options
13
+ # @param [Config] options
14
+ def sourcekitten_output(config)
13
15
  installation_root = Pathname(Dir.mktmpdir(['jazzy', podspec.name]))
14
16
  installation_root.rmtree if installation_root.exist?
15
17
  Pod::Config.instance.with_changes(installation_root: installation_root) do
@@ -22,9 +24,11 @@ module Jazzy
22
24
  .map(&:label)
23
25
 
24
26
  targets.map do |t|
25
- SourceKitten.run_sourcekitten(
26
- %W(doc --module-name #{podspec.module_name} -- -target #{t}),
27
- )
27
+ args = %W(doc --module-name #{podspec.module_name} -- -target #{t})
28
+ if config.swift_version
29
+ args << "SWIFT_VERSION=\"#{config.swift_version}\""
30
+ end
31
+ SourceKitten.run_sourcekitten(args)
28
32
  end
29
33
  end
30
34
  stdout.reduce([]) { |a, s| a + JSON.load(s) }.to_json
@@ -59,6 +63,10 @@ module Jazzy
59
63
  unless config.github_file_prefix_configured
60
64
  config.github_file_prefix = github_file_prefix(podspec)
61
65
  end
66
+ unless config.swift_version_configured
67
+ trunk_swift_build = podspec.attributes_hash['pushed_with_swift_version']
68
+ config.swift_version = trunk_swift_build if trunk_swift_build
69
+ end
62
70
  end
63
71
  # rubocop:enable Metrics/CyclomaticComplexity
64
72
  # rubocop:enable Metrics/PerceivedComplexity
@@ -159,7 +159,7 @@ module Jazzy
159
159
  }.freeze,
160
160
  'sourcekitten.source.lang.objc.decl.typedef' => {
161
161
  jazzy: 'Type Definition',
162
- dash: 'Alias',
162
+ dash: 'Type',
163
163
  }.freeze,
164
164
  'sourcekitten.source.lang.objc.mark' => {
165
165
  jazzy: 'Mark',
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jazzy
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.2
4
+ version: 0.7.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - JP Simard
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: bin
12
12
  cert_chain: []
13
- date: 2016-09-14 00:00:00.000000000 Z
13
+ date: 2016-12-01 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: cocoapods
@@ -116,14 +116,14 @@ dependencies:
116
116
  requirements:
117
117
  - - "~>"
118
118
  - !ruby/object:Gem::Version
119
- version: 0.2.1
119
+ version: 0.3.0
120
120
  type: :runtime
121
121
  prerelease: false
122
122
  version_requirements: !ruby/object:Gem::Requirement
123
123
  requirements:
124
124
  - - "~>"
125
125
  - !ruby/object:Gem::Version
126
- version: 0.2.1
126
+ version: 0.3.0
127
127
  - !ruby/object:Gem::Dependency
128
128
  name: bundler
129
129
  requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,10 @@ files:
175
175
  - README.md
176
176
  - Rakefile
177
177
  - bin/jazzy
178
+ - images/logo.jpg
179
+ - images/logo.sketch
180
+ - images/realm.png
181
+ - images/screenshot.jpg
178
182
  - jazzy.gemspec
179
183
  - lib/jazzy.rb
180
184
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework
@@ -187,9 +191,9 @@ files:
187
191
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash
188
192
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist
189
193
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash
190
- - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yaml.framework/Versions/A/Resources/Info.plist
191
- - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yaml.framework/Versions/A/Yaml
192
- - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yaml.framework/Yaml
194
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Resources/Info.plist
195
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams
196
+ - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams
193
197
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
194
198
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib
195
199
  - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftDarwin.dylib
@@ -248,10 +252,6 @@ files:
248
252
  - lib/jazzy/themes/fullwidth/templates/parameter.mustache
249
253
  - lib/jazzy/themes/fullwidth/templates/task.mustache
250
254
  - lib/jazzy/themes/fullwidth/templates/tasks.mustache
251
- - logo.jpg
252
- - logo.sketch
253
- - realm.png
254
- - screenshot.jpg
255
255
  - spec/integration_spec.rb
256
256
  - spec/sourcekitten_spec.rb
257
257
  - spec/spec_helper.rb
data/logo.jpg DELETED
Binary file
Binary file