ParamTag (Doclet API)

Package | Class | Use | Tree | Deprecated | Index | Help

Doclet API

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.javadoc
Interface ParamTag

All Superinterfaces:
  Tag

public interface ParamTag
extends Tag

Represents an @param documentation tag. Parses and stores the name and comment parts of the method/constructor parameter tag.

Method Summary
`String` | `parameterComment()` Return the parameter comment associated with this `ParamTag`.
`String` | `parameterName()` Return the name of the parameter associated with this `ParamTag`.

Methods inherited from interface com.sun.javadoc.Tag
`firstSentenceTags, inlineTags, kind, name, position, text, toString`

Method Detail

### parameterName

    public String parameterName()

  Return the name of the parameter associated with this `ParamTag`.

  Returns:
    the parameter name.

### parameterComment

    public String parameterComment()

  Return the parameter comment associated with this `ParamTag`.

  Returns:
    the parameter comment.

Package | Class | Use | Tree | Deprecated | Index | Help

Doclet API

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.