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:
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:
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 thescheme
parameter appears in two places: the portion before the line break appears correctly in the parameter table forscheme
, but the portion after the line break is incorrectly interpreted as being part of the function's description: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 thescheme
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: