realm / jazzy

Soulful docs for Swift & Objective-C
https://realm.io
MIT License
7.34k stars 412 forks source link

"\" symbol does not insert carriage return #430

Open Sega-Zero opened 8 years ago

Sega-Zero commented 8 years ago

Imagine I have this code and comments:

public protocol OloloProto {
    /// Long function description \
    /// Next line description
    /// - Parameter param: Some param
    func samplefunc(param: String)
}

This is the help tooltip rendering in xcode: xcode rendering

This is the web version of this comments: web version


The same issue appears on any level of documentation.

segiddins commented 8 years ago

Hm, so my guess is this is happening since markdown doesn't care about the /

Sega-Zero commented 8 years ago

I mentioned the \ symbol, actually =). </br> is not working either. Any chance to get text wrap behavior in jazzy?

segiddins commented 8 years ago

I mean we're just using red carpet for markdown rendering, perhaps they have an option?

karagraysen commented 7 years ago

Any updates on this?

jpsim commented 7 years ago

No.