Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Several Objective-C issues #541

Open
jpsim opened this issue Apr 23, 2016 · 3 comments
Open

Several Objective-C issues #541

jpsim opened this issue Apr 23, 2016 · 3 comments
Labels
bug priority-low

Comments

@jpsim
Copy link
Collaborator

jpsim commented Apr 23, 2016

See 0xced/XCDYouTubeKit@a86022d

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
  • 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
jpsim referenced this issue in 0xced/XCDYouTubeKit Apr 23, 2016
@0xced
Configure jazzy
a86022d 
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
@jpsim jpsim added the bug label May 19, 2016
@pigeondotdev pigeondotdev self-assigned this Nov 23, 2016
@pigeondotdev
Copy link
Contributor

Any updates on this?

@jpsim
Copy link
Collaborator Author

jpsim commented Nov 26, 2016

None whatsoever.

@0xced
Copy link

0xced commented Dec 23, 2016

I just tried again with jazzy 0.7.3 and the Empty Type Definitions entry in the sidebar with a broken link issue seems solved. All the other issues are still not addressed.

@steipete steipete mentioned this issue Jul 3, 2017
Closed
@pigeondotdev pigeondotdev removed their assignment Nov 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug priority-low
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@0xced @jpsim @pigeondotdev