search

swiftlang / swift

The Swift Programming Language
https://swift.org
Apache License 2.0
66.99k stars 10.32k forks source link

[SR-3783] Swift importer should recognize doxygen comments #46368

Open dabrahams opened 7 years ago

dabrahams commented 7 years ago
Previous ID SR-3783
Radar None
Original Reporter @dabrahams
Type New Feature
Additional Detail from JIRA | | | |------------------|-----------------| |Votes | 0 | |Component/s | Compiler, Source Tooling | |Labels | New Feature, ClangImporter, Documentation | |Assignee | None | |Priority | Medium | md5: bc51b6aaf783b3b2ee625250adff5aa9

Issue Description:

When importing a C or Objective-C library, it would be great if the importer would recognize documentation comments written in their typical formats. Then users would be able to see documentation in playgrounds just the same way they do for Swift doc comments.

belkadan commented 7 years ago

Since Clang has some support for parsing Doxygen-like comments, this isn't out of the question.

dabrahams commented 7 years ago

This would make my work with ICU so much nicer.