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

SymbolGraph mode misses out param docs #1244

Closed
jamgzj opened this issue Apr 7, 2021 · 2 comments · Fixed by #1250
Closed

SymbolGraph mode misses out param docs #1244

jamgzj opened this issue Apr 7, 2021 · 2 comments · Fixed by #1250
Labels
bug

Comments

@jamgzj
Copy link

jamgzj commented Apr 7, 2021

jazzy
--clean
--module ...SDK
--swift-build-tool symbolgraph
--sdk iphoneos
--build-tool-arguments --target,arm64-apple-ios11.0
--swift-version 5.3.2
--output /.../.../...

I use jazzy like above, and i got docs without parameters' introduction of functions
@johnfairh johnfairh added the bug label Apr 7, 2021
@johnfairh johnfairh changed the title Fail to show parameters of function for framework in docs SymbolGraph mode misses out param docs Apr 7, 2021
@johnfairh
Copy link
Collaborator

Thanks - yes I see this. There's an extra bit of valid parameter validation against SourceKit output that needs working around.

@johnfairh johnfairh mentioned this issue May 1, 2021
Merged
@johnfairh
Copy link
Collaborator

Thanks again - fixed in #1250, will be in next release, should be this week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix parameter doc comments for symgraph realm/jazzy
2 participants
@jamgzj @johnfairh