Class JavaTypeDocs

java.lang.Object
uno.anahata.ai.nb.model.java2.JavaTypeDocs
Direct Known Subclasses:
JavaMemberDocs
public class JavaTypeDocs extends Object
A rich result object that represents the outcome of a Javadoc retrieval operation for a JavaType. It leverages the polymorphic nature of JavaType to retrieve docs for classes, inner classes, and members.

  • Field Details

    • javaType

      protected final JavaType javaType

    • javadoc

      protected String javadoc

  • Constructor Details

    • JavaTypeDocs

      public JavaTypeDocs(JavaType javaType) throws Exception
      Constructs a new JavaTypeDocs and attempts to retrieve the Javadoc for the given JavaType.
      Parameters:
      javaType - the type or member to retrieve Javadoc for.
      Throws:
      Exception - if the Javadoc cannot be retrieved.

  • Method Details

    • cleanJavadoc

      protected static String cleanJavadoc(String rawDoc)