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

Update jazzy table of contents #3184

Closed
1ec5 opened this issue Jul 16, 2021 · 2 comments · Fixed by #3439
Closed

Update jazzy table of contents #3184

1ec5 opened this issue Jul 16, 2021 · 2 comments · Fixed by #3439
Assignees
@1ec5
Labels
build Issues related to builds and dependency management. documentation topic: documentation
Milestone
v2.0

Comments

@1ec5
Copy link
Contributor

1ec5 commented Jul 16, 2021

The jazzy table of contents needs to be updated to reflect #3045 and other changes:

WARNING: No documented top-level declarations match name "AccountManager" specified in categories file
WARNING: No documented top-level declarations match name "PointAnnotation" specified in categories file
WARNING: No documented top-level declarations match name "Style" specified in categories file
WARNING: No documented top-level declarations match name "RoadObjectsStore" specified in categories file
WARNING: No documented top-level declarations match name "RoadObjectsStoreDelegate" specified in categories file

#2078 or something like it would help to catch issues like this sooner.

/cc @mapbox/navigation-ios
@1ec5 1ec5 added topic: documentation build Issues related to builds and dependency management. documentation labels Jul 16, 2021
@1ec5 1ec5 added this to the v2.0.0 (GA) milestone Jul 16, 2021
@1ec5 1ec5 self-assigned this Sep 7, 2021
@1ec5
Copy link
Contributor Author

1ec5 commented Sep 16, 2021

Some of these entries will be addressed by #3367.

@1ec5
Copy link
Contributor Author

1ec5 commented Sep 18, 2021

As of v2.0.0-rc.2:

WARNING: No documented top-level declarations match name "AccountManager" specified in categories file
WARNING: No documented top-level declarations match name "PointAnnotation" specified in categories file
WARNING: No documented top-level declarations match name "Style" specified in categories file
WARNING: No documented top-level declarations match name "IncorrectVisualSubtype" specified in categories file
WARNING: No documented top-level declarations match name "RoadObject.Location" specified in categories file
WARNING: No documented top-level declarations match name "RoadObject.Kind" specified in categories file
WARNING: No documented top-level declarations match name "RoadObject.EdgeLocation" specified in categories file
WARNING: No documented top-level declarations match name "RoadObject.Position" specified in categories file
WARNING: No documented top-level declarations match name "RoadObject.Identifier" specified in categories file

I think the RoadObject-related warnings are because jazzy expects e.g. Identifier to be in a list nested under RoadObject, rather than this dot syntax.

@chezzdev chezzdev mentioned this issue Oct 5, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@1ec5 1ec5

Labels
build Issues related to builds and dependency management. documentation topic: documentation
Projects
None yet
Milestone
v2.0
Development

Successfully merging a pull request may close this issue.

Docs generation automation mapbox/mapbox-navigation-ios
1 participant
@1ec5