Package hec.io

Class JavaDocParser

java.lang.Object
hec.io.JavaDocParser
public class JavaDocParser extends Object

  • Field Details

    • logger

      public static final Logger logger

  • Method Details

    • createParser

      public static JavaDocParser createParser(Class cls)

    • getJavaDoc

      public String getJavaDoc()
      get the Java Docs for the class
      Returns:
      the Java Docs for the class

    • getJavaDocFile

      public File getJavaDocFile()
      return the File for the JavaDocs
      Returns:
      the File for the Java Doc page

    • getJavaDocURL

      public URL getJavaDocURL()

    • getJavaDocHome

      public static String getJavaDocHome()
      Gets the JavaDocHome attribute of the JavaDocParser object
      Returns:
      The JavaDocHome value

    • getContructorSyntax

      public String getContructorSyntax(Constructor ctor)

    • getFieldSyntax

      public String getFieldSyntax(Field f)

    • getJavaDocUrl

      public String getJavaDocUrl(Field f)

    • getJavaDoc

      public String getJavaDoc(Field f)

    • getField

      public String getField(Field f)

    • getMethodSyntax

      public String getMethodSyntax(Method m)

    • getMethodSyntaxFromJavaDoc

      public static String getMethodSyntaxFromJavaDoc(String jdoc)

    • getJavaDocUrl

      public String getJavaDocUrl(Constructor ctor)

    • getJavaDoc

      public String getJavaDoc(Constructor ctor)
      Gets the JavaDoc attribute of the JavaDocParser object
      Parameters:
      ctor - Description
      Returns:
      The JavaDoc value

    • getJavaDocUrl

      public String getJavaDocUrl(Method m)
      Parameters:
      m - Method
      Returns:
      String

    • getJavaDoc

      public String getJavaDoc(Method m)
      Gets the JavaDoc attribute of the JavaDocParser object
      Parameters:
      m - Description
      Returns:
      The JavaDoc value

    • close

      public void close()
      Method Description

    • getConstructorCall

      public static String getConstructorCall(Constructor ctor)
      Gets the Constructor Call for the Constructor
      Parameters:
      ctor - Description
      Returns:
      The MethodCall value

    • getMethodCall

      public static String getMethodCall(Method method)
      Gets the MethodCall attribute of the JavaDocParser class
      Parameters:
      method - Description
      Returns:
      The MethodCall value

    • getTypeName

      public static String getTypeName(Class type)
      Gets the TypeName attribute of the JavaDocParser class
      Parameters:
      type - Description
      Returns:
      The TypeName value