search

swiftlang / swift-package-manager

The Package Manager for the Swift Programming Language
Apache License 2.0
9.74k stars 1.34k forks source link

[SR-1303] [SwiftPM] Support for showing "Swift generated interface" #5301

Open aciidgh opened 8 years ago

aciidgh commented 8 years ago
Previous ID SR-1303
Radar None
Original Reporter @aciidb0mb3r
Type New Feature
Additional Detail from JIRA | | | |------------------|-----------------| |Votes | 2 | |Component/s | CodeCompletion, Package Manager | |Labels | New Feature | |Assignee | None | |Priority | Medium | md5: c76bb8d7530e04101dc3b347ddbfdb83

relates to:

Issue Description:

It would be good for swiftpm users to be able to generate Xcode-like public headers of a package so people not using Xcode can view documentation and public APIs of their dependencies. It looks like it is possible to do on OSX using sourcekit and libIDE on linux.
briancroom ran swift-ide-test on swiftpm files and was able to get this result : https://gist.github.com/briancroom/1d2e27c7b94ba7cbd718dbdf88ae3771

abertelrud commented 8 years ago

It's worth discussion but we should consider carefully what we put in SwiftPM and what we leave to other tools that leverage SwiftPM. But if it's an output of the build, it makes sense that it would be SwiftPM that would do it.