work with .swiftdoc generated by swift compiler - appears to take reST as input, not Doxygen/Appledoc style markup about jazzy HOT 5 CLOSED

Very interesting find. How are you parsing the resulting binary?

from jazzy.

@jpsim I just ran vi on it and skimmed for recognizable strings in the soup of binary. My guess is there's additional info about the types added automatically. I haven't had time to dig into trying to reverse the binary format. It's likely Xcode knows how to parse it already, so pointing Hopper at Xcode would be another route for getting hints into the swiftdoc binary structure.

from jazzy.

Ah yes, popped it into a hex editor. Looks like it contains mostly what we already have by running xcrun swift-ide-test -print-comments. Here's a gist showing the structured XML output we get from that.

It would still be useful to support generating docs for pre-compiled .swiftdoc files. So I'll keep this issue open, but that won't be a high priority just yet. Focusing on generating docs from source code first.

from jazzy.

reST indeed. From the Xcode release notes:

"Swift recognizes comments that start with the special marker /** or /// as documentation comments. Swift uses reStructuredText, an easy-to-read, modern lightweight markup language in documentation comments. Currently only block-level markup is supported (nested bullet and enumerated lists, field lists). In order to document function and method parameters, use :param: followed by parameter name, and to document return values use :returns:"

Also see - http://nshipster.com/swift-documentation/

from jazzy.

I looked into the .swiftdoc format, and unfortunately it doesn't have enough information to build comprehensive docs, so I'm closing this for now. We can re-open if Apple adds more information in this file.

from jazzy.