jazzy icon indicating copy to clipboard operation
jazzy copied to clipboard

Tolerate extra leading spaces after * in multiline comments.

Open mikelehen opened this issue 8 years ago • 1 comments

When parsing a comment with a style like this:

/** Multiline comment
 *  with subsequent lines indented two spaces
 *  breaks Jazzy.
 */

Jazzy ends up producing documentation like:

Multiline comment * with subsequent lines indented two spaces * breaks Jazzy.

It would be great if Jazzy would tolerate extra leading whitespace.

mikelehen avatar Nov 29 '16 20:11 mikelehen

@mikelehen if you'd like to fix this, the code that parses these kinds of comments lives in SourceKitten and is entirely written in Swift, which should make it easier if you don't have any Ruby experience.

https://github.com/jpsim/SourceKitten/blob/0.15.2/Source/SourceKittenFramework/String+SourceKitten.swift#L538-L559

jpsim avatar Dec 07 '16 20:12 jpsim