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

Add support for ObjC/C Package #55

Open
2 tasks done
Kyle-Ye opened this issue Apr 23, 2023 · 2 comments
Open
2 tasks done

Add support for ObjC/C Package #55

Kyle-Ye opened this issue Apr 23, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Apr 23, 2023

Add support for ObjC/C Package

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected behavior

Generate docc preview successfully.

Actual behavior

error: target 'XX' is not a Swift source module

Steps to Reproduce

  1. Init an empty C Package and add Documentation Catalog(XX.docc foloder).
  2. Add Swift-DocC-Plugin depenedency
  3. Run swift package --disable-sandbox preview-documentation --target XX

Swift-DocC Plugin Version Information

Swift-DocC plugin version: 1.1.0
Swift Compiler version:

swift-driver version: 1.75.2 Apple Swift version 5.8 (swiftlang-5.8.0.124.2 clang-1403.0.22.11.100)
Target: arm64-apple-macosx13.0
@Kyle-Ye Kyle-Ye added the bug Something isn't working label Apr 23, 2023
@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Apr 23, 2023

We've already got clang support for ObjectiveC symbol graph generation. But this method need multi commands to achieve. It would be nice if Swift DocC Plugin could do them for us.

https://forums.swift.org/t/clang-support-for-objective-c-symbol-graph-generation/57689

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Apr 23, 2023

I just summarized Swift-docc-plugin's support for ObjC & Swift language with a repository.

For anyone interested, you can check it here https://github.com/Kyle-Ye/swift-docc-plugin-mix-demo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant