Lint to end the first paragraph of doc comments with a period.

[pq]

From the Doc Comment Guidelines:

DO end the first paragraph of your doc comment (the summary) with a period (.).

The first paragraph of a doc comment is special. After that, the content is up to you, although we strongly recommend including code samples.

The first paragraph of any doc comment is a brief, user-oriented description ending with a period. It is not a complete sentence.

The description should help the reader understand whether this bit of API might be useful to them, compared to similar sounding API. Never just repeat the API name; try to restate it to give more information than the name alone provides. Avoid links when possible.

GOOD:

• Returns true if every element of this collection satisfies the predicate [f].
• Starts the stopwatch.

BAD:

• Gets the current time