de.unkrig.commons.doclet

Class Tags

java.lang.Object

de.unkrig.commons.doclet.Tags

public final class Tags
extends Object

Utility methods related to doclet tags.

Method Summary

Modifier and Type	Method and Description
static com.sun.javadoc.Tag	optionalTag(com.sun.javadoc.Doc doc, String tagName, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named block tag exists at most once, and returns it.
static com.sun.javadoc.Tag	requiredTag(com.sun.javadoc.Doc doc, String tagName, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named block tag exists exactly once, and returns it.

Methods inherited from class java.lang.Object

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

Method Detail

optionalTag

@Nullable
public static com.sun.javadoc.Tag optionalTag(com.sun.javadoc.Doc doc,
                                                         String tagName,
                                                         com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named block tag exists at most once, and returns it.

Returns:

null iff the tag does not exist

requiredTag

public static com.sun.javadoc.Tag requiredTag(com.sun.javadoc.Doc doc,
                                              String tagName,
                                              com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named block tag exists exactly once, and returns it.