Class Javadoc

java.lang.Object
io.helidon.codegen.classmodel.Javadoc
public final class Javadoc extends Object
Javadoc model representation.
Javadoc tags are printed out in the ordering of:
  • parameters
  • generic arguments
  • return
  • throws
  • deprecated
  • everything else

  • Method Details

    • parse

      public static Javadoc parse(String fullJavadocString)
      Parse Javadoc model object from the String.
      Parameters:
      fullJavadocString - javadoc string
      Returns:
      new javadoc instance

    • parse

      public static Javadoc parse(List<String> fullJavadocLines)
      Parse Javadoc model object from the list of strings.
      Parameters:
      fullJavadocLines - javadoc string lines
      Returns:
      new javadoc instance

    • builder

      public static Javadoc.Builder builder()
      Create new Javadoc.Builder instance.
      Returns:
      new builder instance

    • builder

      public static Javadoc.Builder builder(Javadoc javadoc)
      Create new Javadoc.Builder instance.
      Parameters:
      javadoc - existing javadoc to copy
      Returns:
      new builder instance

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • content

      public List<String> content()
      Content of this javadoc.
      Returns:
      content

    • parameters

      public Map<String, List<String>> parameters()
      Parameter tags names and descriptions.
      Returns:
      parameter tags

    • genericsTokens

      public Map<String, List<String>> genericsTokens()
      Generic parameter tags names and descriptions.
      Returns:
      generic parameter tags

    • returnDescription

      public List<String> returnDescription()
      Return type description.
      Returns:
      return type description

    • throwsDesc

      public Map<String, List<String>> throwsDesc()
      Throws tags names and descriptions.
      Returns:
      throws tags

    • deprecation

      public List<String> deprecation()
      Deprecation description.
      Returns:
      deprecation description

    • otherTags

      public Map<String, List<List<String>>> otherTags()
      Other created tags with descriptions.
      Returns:
      other tags