Skip to content

Commit

Permalink
Configure jazzy
Browse files Browse the repository at this point in the history
There are still a lot of issues to be solved before jazzy can be used instead of appledoc. (Tested with jazzy 0.6.0)

* No [explicit cross-references][1]
* `XCDYouTubeVideoPlayerViewController` class is _Undocumented_ because of the `#pragma clang diagnostic` surrounding it
* `-[XCDYouTubeVideo streamURLs]` documentation is buggy because of the surrounding `#if __has_feature(objc_generics)`
* Deprecated is not properly (visually) handled for `XCDYouTubeVideoQualityHD1080`
* Deprecated notification constants are not handled at all
* @discussion is not properly (visually) handled
* Empty _Type Definitions_ entry in the sidebar with a broken link
* Truncated classes and constants names in the sidebar

[1]: https://github.com/tomaz/appledoc/wiki/appledoc-docs-examples-advanced#controlling-cross-references-detection
  • Loading branch information
0xced committed Apr 22, 2016
1 parent 707cecc commit a86022d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
objc: true
sdk: iphonesimulator
source_directory: XCDYouTubeKit
framework_root: .
umbrella_header: XCDYouTubeKit/XCDYouTubeKit.h
module: XCDYouTubeKit
module_version: 2.5.2

author: Cédric Luthi
author_url: https://twitter.com/0xced

readme: README.md
github_url: https://github.com/0xced/XCDYouTubeKit
github_file_prefix: https://github.com/0xced/XCDYouTubeKit/tree/2.5.2/XCDYouTubeKit

1 comment on commit a86022d

@jpsim
Copy link

@jpsim jpsim commented on a86022d Apr 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing up all the (unfortunately) broken things you found! I just filed an umbrella ticket to address these problems in jazzy here realm/jazzy#541

Please sign in to comment.