Interface DocletOutput.DocVariable

Enclosing interface:
DocletOutput

public static interface DocletOutput.DocVariable
Characterises a method parameter.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns parameter description.
    Returns parameter name.
    Returns parameter type in user-friendly form.
  • Method Details

    • getName

      String getName()
      Returns parameter name.
      Returns:
      name
    • getType

      String getType()
      Returns parameter type in user-friendly form.
      Returns:
      type specification
    • getCommentText

      String getCommentText()
      Returns parameter description.
      Returns:
      description, may be HTML