klyn.code.klyn.KlynDocComment.mainDescription
method
public static mainDescription(text as String) as String
Description

Extracts the main description body prior to the first @ tag line.

Parameters
ParameterDescription
textCleaned documentation text.
Returns

Main narrative description.

Example
import klyn.code.klyn

doc = "Main description.\n\n@return Nothing."
assert KlynDocComment.mainDescription(doc) == "Main description."