Overview > klyn.code.klyn > KlynDocComment > firstSentence
Version 0.2.1 Overview Index Tree Deprecated
klyn.code.klyn.KlynDocComment.firstSentence
method
public static firstSentence(value as String) as String
Description

Extracts the first summary sentence from a cleaned documentation comment. Dots inside backtick code spans (e.g. klyn.Type ) do not prematurely end the sentence.

Parameters
ParameterDescription
valueCleaned documentation comment text.
Returns

First sentence summary.

Example
import klyn.code.klyn

doc = "Resolves `klyn.Type` instances. More details follow."
assert KlynDocComment.firstSentence(doc) == "Resolves `klyn.Type` instances."