appledoc icon indicating copy to clipboard operation
appledoc copied to clipboard

Published 20 hours ago • verified publisher icon tomaz

Swift Code Issue

Open Rahulgupta-cdnsol opened this issue 10 years ago • 4 comments

Hi,

I am using swift code so run script not working in swift code and not generate any kind of doc. Please have a look and provide solution for this.

Thanks, Rahul

Rahulgupta-cdnsol avatar May 04 '15 13:05 Rahulgupta-cdnsol

Swift is currently not supported.

First of all swift parser would need to be implemented. I'm leaning towards removing custom parsing engine and use clang instead. But there's no such tool for Swift that I know of.

And then it would be good idea to support native format so that code comments would be usable in Xcode and generated HTML (http://nshipster.com/swift-documentation/). Given rapid pace of Swift development, I'd wait until it stabilizes before committing to developing anything on top of it.

tomaz avatar May 04 '15 13:05 tomaz

@tomaz,

The SourceKitten project from @jpsim seems like it might be useful for that. It's the backend of the Jazzy documentation generator for Swift from @Realm (via @jpsim & @segiddins).

SourceKitten should obviate the need for building your own Swift parser.

emaloney avatar May 04 '15 14:05 emaloney

@emaloney Thanks, I'm aware of SourceKitten and Jazzy, forgot about it... I have it listed on my to-check list for 3.0

tomaz avatar May 04 '15 14:05 tomaz

Heyo! Happy to help, I've always been a fan of appledoc and even though jazzy overlaps, they can totally coexist.

jpsim avatar May 04 '15 17:05 jpsim