jazzy 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09d1714bfe2ecc1fa4759c51094866893caf0e1d
-  data.tar.gz: 6e447e7da342c775039b2816f0a3838fe3e3bdae
+  metadata.gz: 4344d4e194eb9396ad55aa2a2050eed88aa2c30f
+  data.tar.gz: 4a6c9ee2d83e5870ac85bd9e49a19a31e0c7a544
 SHA512:
-  metadata.gz: cacce7a31c93f19765926d5f40462cac358c573d7312e74f784590ce38c0c918acaa812f15c5c5e37b90b6cc27e9f8123f6b88a1dce8e207a544523402787b45
-  data.tar.gz: 6a362da7dd06266d0374aee0f8e50f5d3afbc52cf3e30bfa6520590b7782d371f599f70ac4eb277b695a05b6b130386455525f577d7b8b4f0b226247ceae57d5
+  metadata.gz: 99eaf5f9ea98dcddd743ab0714fbe8baef5bdc82021b8a175a9e483790b58bc5469131e1dadd12df05d4b36728b2f8ea1580088246a57e0709b44e5bc706d736
+  data.tar.gz: 654f71a20888a547d17a5aa6614d07de567bce7ff2f28addb84a403fd4822f58f1636fbd4573861c5c692589b1b1fa33995fa2ecd2963649999aa9a529def9ae

data/.rubocop.yml

@@ -3,6 +3,10 @@ AllCops:
     - ./Rakefile
     - ./Gemfile
     - ./*.gemspec
+  Exclude:
+    - ./spec/integration_specs/**/*
+    - ./vendor/**/*
+    - ./tmp/**/*
 
 # At the moment not ready to be used
 # https://github.com/bbatsov/rubocop/issues/947
@@ -15,6 +19,12 @@ Documentation:
 Metrics/MethodLength:
   Max: 20
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
 # We adopted raise instead of fail.
 SignalException:
   EnforcedStyle: only_raise
@@ -47,6 +57,23 @@ TrailingComma:
 Style/SpecialGlobalVars:
   Enabled: false
 
+# For lambdas nested within certain expressions, this rule forces either ugly
+# parens or curly braces that violate the "do/end for multiline blocks" rule.
+Lambda:
+  Enabled: false
+
+# Disallowing indented "when" clauses destroys readability when using the
+# single-line "when/then" style.
+CaseIndentation:
+  Enabled: false
+
+# These are both subjective judgements that depend on the situation, and are
+# not appropriate as absolute rules.
+GuardClause:
+  Enabled: false
+Next:
+  Enabled: false
+
 #- Jazzy specs -----------------------------------------------------------#
 
 # Allow for `should.match /regexp/`.

data/.travis.yml

@@ -13,5 +13,5 @@ matrix:
   include:
     - osx_image: xcode6.4
       env: TRAVIS_SWIFT_VERSION=1.2
-    - osx_image: xcode7
-      env: TRAVIS_SWIFT_VERSION=2.0
+    - osx_image: xcode7.1
+      env: TRAVIS_SWIFT_VERSION=2.1

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+## 0.4.0
+
+##### Breaking
+
+* `--swift-version` now defaults to 2.1 instead of 2.0.  
+  [JP Simard](https://github.com/jpsim)
+
+##### Enhancements
+
+* Support for documenting Objective-C projects! 🎉
+  Pass `--objc`, `--umbrella-header ...` and `-framework-root ...`.  
+  [JP Simard](https://github.com/jpsim)
+  [#56](https://github.com/realm/jazzy/issues/56)
+
+* Mentions of top-level declarations in documentation comments are now
+  automatically hyperlinked to their reference.  
+  [JP Simard](https://github.com/jpsim)
+
+* Jazzy can now read options from a configuration file. The command line
+  provides comprehensive help for available options via `jazzy -h config`.  
+  [pcantrell](https://github.com/pcantrell)
+  [#310](https://github.com/realm/jazzy/pull/310)
+
+* Render special list items (e.g. Throws, See, etc.). See
+  http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for
+  a complete list.  
+  [JP Simard](https://github.com/jpsim)
+  [#317](https://github.com/realm/jazzy/issues/317)
+
+* Support for Swift 2.1.  
+  [JP Simard](https://github.com/jpsim)
+
+* Swift extensions are now merged with their extended type, rendering a note
+  to describe extension default implementations and extension methods.  
+  [pcantrell](https://github.com/pcantrell)
+
+##### Bug Fixes
+
+* None.
+
+
 ## 0.3.2
 
 ##### Breaking

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.3.2)
+    jazzy (0.4.0)
       cocoapods (~> 0.38)
       mustache (~> 0.99)
       open4
@@ -21,9 +21,9 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.6)
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     bacon (1.2.0)
     claide (0.9.1)
     clintegracon (0.5.3)
@@ -76,26 +76,24 @@ GEM
     nap (0.8.0)
     netrc (0.7.8)
     open4 (1.3.4)
-    parser (2.2.0.pre.5)
+    parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
-      slop (~> 3.4, >= 3.4.5)
-    powerpack (0.0.9)
+    powerpack (0.1.1)
     prettybacon (0.0.2)
       bacon (~> 1.2)
     rainbow (2.0.0)
     rake (10.3.2)
     redcarpet (3.3.3)
     rouge (1.10.1)
-    rubocop (0.26.1)
+    rubocop (0.34.2)
       astrolabe (~> 1.3)
-      parser (>= 2.2.0.pre.4, < 3.0)
-      powerpack (~> 0.0.6)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.6.0)
+    ruby-progressbar (1.7.5)
     safe_yaml (1.0.4)
     sass (3.4.18)
-    slop (3.6.0)
     sqlite3 (1.3.10)
     thread_safe (0.3.5)
     tzinfo (1.2.2)

data/README.md

@@ -7,8 +7,9 @@
 jazzy is a command-line utility that generates documentation for your Swift or
 Objective-C projects.
 
-Only Swift projects are currently supported, but Objective-C support is coming
-soon!
+Both Swift & Objective-C projects are supported.
+
+*Objective-C support was recently added, so please report any issues you find.*
 
 Instead of parsing your source files, jazzy hooks into [Clang][clang] and
 [SourceKit][sourcekit] to use the [AST][ast] representation of your code and
@@ -21,10 +22,8 @@ documentation, post WWDC 2014.
 
 ### Requirements
 
-* A 6.x version of [Xcode][xcode] capable of building the Swift project
-  you wish to document, installed anywhere under `/Applications`.
-  Support for Xcode 7 betas is in progress (see
-  [#261](https://github.com/realm/jazzy/pull/261)).
+* A version of [Xcode][xcode] (6.x or 7.x) capable of building the Swift project
+  you wish to document, installed in a location indexed by Spotlight.
 
 ### Installing
 
@@ -35,22 +34,89 @@ To install jazzy, run `[sudo] gem install jazzy` from your command line.
 Run `jazzy` from your command line. Run `jazzy -h` for a list of additional
 options.
 
+You can set options for your project’s documentation in a configuration file,
+`.jazzy.yaml` by default. For a detailed explanation and an exhaustive list of
+all available options, run `jazzy --help config`.
+
+#### Swift
+
+Swift documentation is generated by default.
+
+As an example, this is how Realm Swift docs are generated:
+
+```shell
+jazzy \
+  --clean \
+  --author Realm \
+  --author_url https://realm.io \
+  --github_url https://github.com/realm/realm-cocoa \
+  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \
+  --module-version 0.96.2 \
+  --xcodebuild-arguments -scheme,RealmSwift \
+  --module RealmSwift \
+  --root-url https://realm.io/docs/swift/0.96.2/api/ \
+  --output docs/swift_output \
+  --template-directory docs/templates
+```
+
+#### Objective-C
+
+To generate documentation for Objective-C headers, you should pass `--objc`,
+`--umbrella-header ...` and `-framework-root ...` as parameters to jazzy.
+
+As an example, this is how Realm Objective-C docs are generated:
+
+```shell
+jazzy \
+  --objc \
+  --clean \
+  --author Realm \
+  --author_url https://realm.io \
+  --github_url https://github.com/realm/realm-cocoa \
+  --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \
+  --module-version 0.96.2 \
+  --umbrella-header Realm/Realm.h \
+  --framework-root . \
+  --module Realm \
+  --root-url https://realm.io/docs/objc/0.96.2/api/ \
+  --output docs/objc_output \
+  --template-directory docs/templates
+```
+
+or AFNetworking:
+
+```shell
+jazzy \
+  --objc \
+  --author AFNetworking \
+  --author_url http://afnetworking.com \
+  --github_url https://github.com/AFNetworking/AFNetworking \
+  --github-file-prefix https://github.com/AFNetworking/AFNetworking/tree/2.6.2 \
+  --module-version 2.6.2 \
+  --umbrella-header AFNetworking/AFNetworking.h \
+  --framework-root . \
+  --module AFNetworking
+```
+
 ### Troubleshooting
 
-#### Only extensions are listed in the documentation.
-By default, jazzy only documents public declarations. To generate documentation for declarations with a lower accessibility level (internal or private), please set the `--min-acl` flag to `internal` or `private`.
+#### Swift: Only extensions are listed in the documentation.
+
+By default, jazzy only documents public declarations. To generate documentation
+for declarations with a lower accessibility level (internal or private), please
+set the `--min-acl` flag to `internal` or `private`.
 
 ### Development
 
-jazzy is composed of two parts: the parser ([sourcekitten][sourcekitten],
+jazzy is composed of two parts: the parser ([SourceKitten][SourceKitten],
 written in Swift) and the site generator (written in ruby).
 
 To build and run jazzy from source, you'll first need [bundler][bundler]. Once
 bundler is installed, run `bundle install` from the root of this repo. At this
 point, run jazzy from source by running `bin/jazzy`.
 
-Instructions to build sourcekitten from source can be found at
-[sourcekitten's GitHub repository][sourcekitten].
+Instructions to build SourceKitten from source can be found at
+[SourceKitten's GitHub repository][SourceKitten].
 
 ### Design Goals
 
@@ -60,8 +126,8 @@ jazzy's main design goals are:
 - Support for standard Objective-C and Swift documentation comment syntax
 - Leverage modern HTML templating ([Mustache][mustache])
 - Leverage the power and accuracy of the [Clang AST][ast] and [SourceKit][sourcekit]
-- Support for Xcode and Dash docsets (*work in progress*)
-- Support Swift, Objective-C or mixed projects (*work in progress*)
+- Support for Dash docsets
+- Support Swift & Objective-C (*mixed projects are a work in progress*)
 
 ### License
 
@@ -71,6 +137,6 @@ This project is under the MIT license.
 [sourcekit]: http://www.jpsim.com/uncovering-sourcekit "Uncovering SourceKit"
 [ast]: http://clang.llvm.org/docs/IntroductionToTheClangAST.html "Introduction To The Clang AST"
 [xcode]: https://developer.apple.com/xcode "Xcode"
-[sourcekitten]: https://github.com/jpsim/sourcekitten "sourcekitten"
+[SourceKitten]: https://github.com/jpsim/SourceKitten "SourceKitten"
 [bundler]: http://rubygems.org/gems/bundler
 [mustache]: http://mustache.github.io "Mustache"

data/Rakefile

@@ -71,9 +71,7 @@ begin
   #-- RuboCop ----------------------------------------------------------------#
 
   require 'rubocop/rake_task'
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    task.patterns = %w(lib spec/*.rb Rakefile Gemfile jazzy.gemspec)
-  end
+  RuboCop::RakeTask.new(:rubocop)
 
   #-- SourceKitten -----------------------------------------------------------#
 

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15B30a</string>
+	<string>15B42</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0</string>
+	<string>0.6.1</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0701</string>
+	<string>0710</string>
 	<key>DTXcodeBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2014 Carthage. All rights reserved.</string>
 </dict>

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15B30a</string>
+	<string>15B42</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0701</string>
+	<string>0710</string>
 	<key>DTXcodeBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2015 Rob Rix. All rights reserved.</string>
 </dict>

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15B30a</string>
+	<string>15B42</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0701</string>
+	<string>0710</string>
 	<key>DTXcodeBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>UIDeviceFamily</key>
 	<array>
 		<integer>1</integer>

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SwiftXPC.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15B30a</string>
+	<string>15B42</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>1.1.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>
@@ -29,7 +29,7 @@
 	<key>DTCompiler</key>
 	<string>com.apple.compilers.llvm.clang.1_0</string>
 	<key>DTPlatformBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>DTPlatformVersion</key>
 	<string>GM</string>
 	<key>DTSDKBuild</key>
@@ -37,9 +37,9 @@
 	<key>DTSDKName</key>
 	<string>macosx10.11</string>
 	<key>DTXcode</key>
-	<string>0701</string>
+	<string>0710</string>
 	<key>DTXcodeBuild</key>
-	<string>7A1001</string>
+	<string>7B91b</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2014 JP Simard. All rights reserved.</string>
 </dict>