com.puppycrawl.tools.checkstyle.checks.javadoc.utils

Class InlineTagUtil

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil

public final class InlineTagUtil
extends java.lang.Object

Tools for extracting inline tags from Javadoc comments.

Method Summary

Modifier and Type	Method and Description
static java.util.List<TagInfo>	extractInlineTags(java.lang.String... lines) Extract inline Javadoc tags from the given comment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

extractInlineTags

public static java.util.List<TagInfo> extractInlineTags(java.lang.String... lines)

Extract inline Javadoc tags from the given comment.

Parameters:

lines - The Javadoc comment (as lines).

Returns:

The extracted inline Javadoc tags.

Throws:

java.lang.IllegalArgumentException - when comment lines contain newlines