com.liferay.portal.kernel.javadoc

Class JavadocMethod

java.lang.Object

com.liferay.portal.kernel.javadoc.BaseJavadoc

com.liferay.portal.kernel.javadoc.JavadocMethod

Direct Known Subclasses:

EmptyJavadocMethod, JavadocMethodImpl

public abstract class JavadocMethod
extends BaseJavadoc

Author:

Preston Crary

Constructor Summary

Constructors

Constructor and Description
JavadocMethod(java.lang.String servletContextName, java.lang.String comment)

Method Summary

Modifier and Type	Method and Description
abstract java.lang.reflect.Method	getMethod()
abstract java.lang.String	getParameterComment(int index)
abstract java.lang.String	getReturnComment()
abstract java.lang.String	getThrowsComment(int index)

Methods inherited from class com.liferay.portal.kernel.javadoc.BaseJavadoc

getComment, getServletContextName

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocMethod

public JavadocMethod(java.lang.String servletContextName,
                     java.lang.String comment)

Method Detail

getMethod

public abstract java.lang.reflect.Method getMethod()

getParameterComment

public abstract java.lang.String getParameterComment(int index)

getReturnComment

public abstract java.lang.String getReturnComment()

getThrowsComment

public abstract java.lang.String getThrowsComment(int index)