1. /*
  2. * @(#)ParamTag.java 1.9 03/12/19
  3. *
  4. * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
  5. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
  6. */
  7. package com.sun.javadoc;
  8. /**
  9. * Represents an @param documentation tag.
  10. * Stores the name and comment parts of the parameter tag.
  11. * An @param tag may represent either a method or constructor parameter,
  12. * or a type parameter.
  13. *
  14. * @author Robert Field
  15. *
  16. */
  17. public interface ParamTag extends Tag {
  18. /**
  19. * Return the name of the parameter or type parameter
  20. * associated with this <code>ParamTag</code>.
  21. * The angle brackets delimiting a type parameter are not part of
  22. * its name.
  23. *
  24. * @return the parameter name.
  25. */
  26. String parameterName();
  27. /**
  28. * Return the parameter comment
  29. * associated with this <code>ParamTag</code>.
  30. *
  31. * @return the parameter comment.
  32. */
  33. String parameterComment();
  34. /**
  35. * Return true if this <code>ParamTag</code> corresponds to a type
  36. * parameter. Return false if it corresponds to an ordinary parameter
  37. * of a method or constructor.
  38. *
  39. * @return true if this <code>ParamTag</code> corresponds to a type
  40. * parameter.
  41. * @since 1.5
  42. */
  43. boolean isTypeParameter();
  44. }