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.

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

Declarations, parameters missing in jazzy documentation #2312

Closed
1ec5 opened this issue Jan 15, 2020 · 0 comments · Fixed by #2313
Closed

Declarations, parameters missing in jazzy documentation #2312

1ec5 opened this issue Jan 15, 2020 · 0 comments · Fixed by #2313
Assignees
Labels
build Issues related to builds and dependency management. documentation topic: documentation
Milestone

Comments

@1ec5
Copy link
Contributor

1ec5 commented Jan 15, 2020

The published jazzy documentation only contains abstracts, no declarations or parameter listings. As a result, permalinks to individual methods are also broken, and overloaded methods are difficult to distinguish from each other.

Additionally, document.sh produces a litany of warnings along the lines of:

`route` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.
`directions` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.
`pendingCamera` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.
`origin` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.
`delegate` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project. If this token is declared in an `#if` block, please ignore this message.

This is a regression of #1795 that would be caught by #2078. It reproduces in the documentation for v1.0.0-alpha.1 but not for v0.38.2. I’m pretty sure this is fallout from #2275 that would be fixed by renaming MapboxCoreNavigation/Route.swift to something else that doesn’t conflict with MapboxNavigation/Route.swift.

/cc @mapbox/navigation-ios

@1ec5 1ec5 added topic: documentation build Issues related to builds and dependency management. documentation labels Jan 15, 2020
@1ec5 1ec5 added this to the v1.0.0 milestone Jan 15, 2020
@1ec5 1ec5 self-assigned this Jan 15, 2020
@1ec5 1ec5 modified the milestones: v1.0.0, v0.x next Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues related to builds and dependency management. documentation topic: documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant