search

swiftlang / swift

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

[SR-1784] Create Doxygen Code Documentation for compiler #44393

Open ahoppen opened 8 years ago

ahoppen commented 8 years ago
Previous ID SR-1784
Radar None
Original Reporter @ahoppen
Type New Feature
Additional Detail from JIRA | | | |------------------|-----------------| |Votes | 0 | |Component/s | Project Infrastructure | |Labels | New Feature | |Assignee | None | |Priority | Medium | md5: ad4ccdc9691452fc1c5686f5827b3498

Issue Description:

I think, the build-script for the swift compiler should generate a Doxygen code documentation of the Swift compiler code.

Looking at the current build-script it seems like there used to support for such a documentation generation, but at least for me, it doesn’t work since Doxygen is not found.

belkadan commented 8 years ago

Yeah, we've never actually set this up. We mostly just inherited it from LLVM/Clang. Would definitely be nice for someone to do it.

ahoppen commented 8 years ago

Note to anyone who wants to get the Doxygen documentation going:

I implemented a standalone documentation generation that doesn't integrate with LLVM in https://github.com/ahoppen/swift/tree/SR-1784-doxygen. However, integration with the LLVM doxygen target should be provided as noted my PR #3477. I think, the doxygen.cfg.in and doxygen.(header|footer) of my branch could be helpful if anyone decides to take on this issue.