Interface DocFuncData

  • All Known Implementing Classes:
    DocForFunc, ExampleDocData

    public interface DocFuncData
    Provide data about a function, suitable for building a documentation site.
    • Method Summary

      Modifier and Type Method Description
      Category[] getCategories()  
      java.lang.String getClassJavadoc()
      Javadoc for the class, or null if there is none.
      java.lang.String getClassName()  
      java.util.List<DocCtorData> getCtors()
      The list of constructors for this documented type.
      java.lang.String getInType()
      The input type for the apply method in the documented function class.
      java.lang.String getOutType()
      The output type for the apply method in the documented function class.
      java.lang.String getPackageName()  
    • Method Detail

      • getPackageName

        java.lang.String getPackageName()
        Returns:
        the package name for the documented type
      • getCategories

        Category[] getCategories()
        Returns:
        Return the categories for this function.
      • getClassName

        java.lang.String getClassName()
        Returns:
        the the Class.getSimpleName() of the class element
      • getClassJavadoc

        java.lang.String getClassJavadoc()
        Javadoc for the class, or null if there is none.
        Returns:
        a String of class javadoc data, or null if none
      • getInType

        java.lang.String getInType()
        The input type for the apply method in the documented function class. Documented function classes must always implement a Java 8 functional interface.
        Returns:
        the input type name
      • getOutType

        java.lang.String getOutType()
        The output type for the apply method in the documented function class. Documented function classes must always implement a Java 8 functional interface.
        Returns:
        the output type name
      • getCtors

        java.util.List<DocCtorData> getCtors()
        The list of constructors for this documented type.
        Returns:
        a list of constructor models