swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/apple/swift-docc-plugin/1.3.0/documentation/swiftdoccplugin
Apache License 2.0
316 stars 54 forks source link

Add Clang source module support #56

Closed Kyle-Ye closed 1 week ago

Kyle-Ye commented 1 year ago

Bug/issue #, if applicable:

Summary

https://github.com/Kyle-Ye/swift-docc-plugin-mix-demo#swift-doc-for-objetivec-module

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

Kyle-Ye commented 1 year ago

@ethan-kusters Could you add the PR link you mentioned on the Swift Documentation Workgroup meeting? Thanks

Kyle-Ye commented 1 year ago

It works fine to generate Swift symbol-graph for a clang target using the existing SwiftPM API.

Download the following code example and run swift package --disable-sandbox preview-documentation --target CKit CKit.zip

image
d-ronnqvist commented 1 week ago

IIUC this functionality is implemented by https://github.com/swiftlang/swift-docc-plugin/pull/95 instead.

Kyle-Ye commented 1 week ago

IIUC this functionality is implemented by #95 instead.

Thanks for getting this issue resolved! I noticed that my earlier PR addressed a similar fix but hasn't received much attention for a while. I'm curious if there might be any internal processes or factors that influenced the prioritization of this one. Does being an Apple employee play any role in the review process?

Looking forward to understanding more about how things work. Thanks again!

Kyle-Ye commented 1 week ago

Also noticed the main difference between #95 and this one is some wording change (e.g change "is not a Swift module" to "is not a Swift/Clang module") and the addition of "any" for the existential module instance.

Curious if these changes warranted a new PR.

Would appreciate any insights. Thanks again!