org.multijava.mjdoc.mjdoc_142
Class MjParamTag

java.lang.Object
  org.multijava.mjdoc.mjdoc_142.MjTag
      org.multijava.mjdoc.mjdoc_142.MjParamTag

All Implemented Interfaces:

com.sun.javadoc.ParamTag, com.sun.javadoc.Tag

public class MjParamTag

extends MjTag

implements com.sun.javadoc.ParamTag

This class represents a javadoc comment @param tag; it is special in that it has a parameter name as well as a decription.

Author:

David R. Cok

Field Summary
private  String	comment           The description associated with the parameter (but you normally should use the sequence of tags provided by inlineTags() ).
static String	KIND           A constant defining the 'kind' of this tag.
private  String	parameterName           A holder for the name of the parameter begin documented.

 

Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjTag

fstags, owner, position, tags

 

Constructor Summary

MjParamTag(com.sun.javadoc.Doc owner, String t, com.sun.javadoc.SourcePosition pos)           The constructor for an instance of this class; the argument is the text that follows the '@param' in a javadoc comment; it will be parsed into the parameter name and the sequence of text and inline tags that make up the description.

 

Method Summary
String	kind()           Returns the 'kind' of the parameter as required by the Tag interface.
String	parameterComment()           Accessor for the unprocessed comment (normally you would use inlineTags() ).
String	parameterName()           Accessor for the name of the paramater being documented.

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjTag

containingClass, create, firstSentenceTags, holder, inlineTags, inlineTags, name, position, resolveReference, text, toString

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface com.sun.javadoc.Tag

firstSentenceTags, holder, inlineTags, name, position, text, toString

 

Field Detail

KIND

public static final String KIND

A constant defining the 'kind' of this tag.

parameterName

private String parameterName

A holder for the name of the parameter begin documented.

comment

private String comment

The description associated with the parameter (but you normally should use the sequence of tags provided by inlineTags() ).

MjParamTag

public MjParamTag(com.sun.javadoc.Doc owner,
                  String t,
                  com.sun.javadoc.SourcePosition pos)

The constructor for an instance of this class; the argument is the text that follows the '@param' in a javadoc comment; it will be parsed into the parameter name and the sequence of text and inline tags that make up the description.

Parameters:

t - unparsed text (parameter name and description)

parameterComment

public String parameterComment()

Accessor for the unprocessed comment (normally you would use inlineTags() ).

Specified by:

parameterComment in interface com.sun.javadoc.ParamTag

parameterName

public String parameterName()

Accessor for the name of the paramater being documented.

Specified by:

parameterName in interface com.sun.javadoc.ParamTag

kind

public String kind()

Returns the 'kind' of the parameter as required by the Tag interface.

Specified by:

kind in interface com.sun.javadoc.Tag