- Revision
- 733
- Author
- rfscholte
- Date
- 2010-06-10 13:47:31 -0500 (Thu, 10 Jun 2010)
Log Message
add some javadoc
Modified Paths
Diff
Modified: trunk/qdox/src/java/com/thoughtworks/qdox/model/JavaMethod.java (732 => 733)
--- trunk/qdox/src/java/com/thoughtworks/qdox/model/JavaMethod.java 2010-05-31 20:32:22 UTC (rev 732) +++ trunk/qdox/src/java/com/thoughtworks/qdox/model/JavaMethod.java 2010-06-10 18:47:31 UTC (rev 733) @@ -16,18 +16,37 @@ private String sourceCode; private boolean varArgs; + /** + * The default constructor + */ public JavaMethod() { } + /** + * Create new method without parameters and return type + * + * @param name the name of the method + */ public JavaMethod(String name) { setName(name); } + /** + * Create a new method without parameters + * + * @param returns the return type + * @param name the name of this method + */ public JavaMethod(Type returns, String name) { setReturns(returns); setName(name); } + /** + * + * @return the return type + * @deprecated it is recommended to use getReturnType() + */ public Type getReturns() { return returns; } @@ -54,10 +73,18 @@ return exceptions; } + /** + * + * @return true is this method is a constructor + */ public boolean isConstructor() { return constructor; } + /** + * + * @return true is this method conains varArgs + */ public boolean isVarArgs() { return varArgs; @@ -144,6 +171,11 @@ return getSignature(false, false); } + /** + * Define the return type of this method + * + * @param returns the return type + */ public void setReturns(Type returns) { this.returns = returns; } @@ -410,6 +442,7 @@ } /** + * If a class inherits this method from a generic class or interface, you can use this method to get the resolved return type * * @param resolve * @return @@ -448,6 +481,7 @@ } /** + * If a class inherits this method from a generic class or interface, you can use this method to get the resolved parameter types * * @param resolve * @return the parameter types as array
To unsubscribe from this list please visit:
