search

beltex / SMCKit

Apple SMC library & tool
https://beltex.github.io/SMCKit
MIT License
473 stars 55 forks source link

Line breaks within :param: text not recognized, messes up formatting of other sections #14

Closed emaloney closed 9 years ago

emaloney commented 9 years ago

Jazzy correctly recognizes and interprets line breaks within some blocks (such as :notes: and :returns:) but not in the :param: block.

In the following screenshot, the text from the :param: block for the scheme parameter appears in two places: the portion before the line break appears correctly in the parameter table for scheme, but the portion after the line break is incorrectly interpreted as being part of the function's description:

screen shot 2015-02-23 at 12 06 02 pm

Only the text "Attempts to construct a URL to represent the specified destination." should appear in the description; everything coming after should be part of the scheme parameter description.

The screenshot above is from the latest release of Jazzy (0.1.1 at the time of this writing), and was rendered from the following source:

screen shot 2015-02-23 at 12 06 19 pm

emaloney commented 9 years ago

Closing — erroneously posted to wrong repo. Apologies!

beltex commented 9 years ago

Just saw this now, completely missed it.

No worries! Happened to me before too! :)