Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse ClassBuilder

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.ClassBuilder
public class ClassBuilder extends AbstractBuilder
Builds the summary for a given class.

  • Methodendetails

    • getInstance

      public static ClassBuilder getInstance(AbstractBuilder.Context context, TypeElement typeElement, ClassWriter writer)
      Constructs a new ClassBuilder.
      Parameter:
      context - the build context
      typeElement - the class being documented.
      writer - the doclet specific writer.
      Gibt zurück:
      the new ClassBuilder

    • build

      public void build() throws DocletException
      Beschreibung aus Klasse kopiert: AbstractBuilder
      Build the documentation.
      Angegeben von:
      build in Klasse AbstractBuilder
      Löst aus:
      DocletException - if there is a problem building the documentation

    • buildClassDoc

      protected void buildClassDoc() throws DocletException
      Handles the tag.
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildClassTree

      protected void buildClassTree(Content classContent)
      Build the class inheritance tree documentation.
      Parameter:
      classContent - the content to which the documentation will be added

    • buildClassInfo

      protected void buildClassInfo(Content target) throws DocletException
      Build the class information documentation.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildParamInfo

      protected void buildParamInfo(Content target)
      Build the type parameters and state components of this class.
      Parameter:
      target - the content to which the documentation will be added

    • buildSuperInterfacesInfo

      protected void buildSuperInterfacesInfo(Content target)
      If this is an interface, list all superinterfaces.
      Parameter:
      target - the content to which the documentation will be added

    • buildImplementedInterfacesInfo

      protected void buildImplementedInterfacesInfo(Content target)
      If this is a class, list all interfaces implemented by this class.
      Parameter:
      target - the content to which the documentation will be added

    • buildSubClassInfo

      protected void buildSubClassInfo(Content target)
      List all the classes that extend this one.
      Parameter:
      target - the content to which the documentation will be added

    • buildSubInterfacesInfo

      protected void buildSubInterfacesInfo(Content target)
      List all the interfaces that extend this one.
      Parameter:
      target - the content to which the documentation will be added

    • buildInterfaceUsageInfo

      protected void buildInterfaceUsageInfo(Content target)
      If this is an interface, list all classes that implement this interface.
      Parameter:
      target - the content to which the documentation will be added

    • buildFunctionalInterfaceInfo

      protected void buildFunctionalInterfaceInfo(Content target)
      If this is an functional interface, display appropriate message.
      Parameter:
      target - the content to which the documentation will be added

    • buildDeprecationInfo

      protected void buildDeprecationInfo(Content target)
      If this class is deprecated, build the appropriate information.
      Parameter:
      target - the content to which the documentation will be added

    • buildNestedClassInfo

      protected void buildNestedClassInfo(Content target)
      If this is an inner class or interface, list the enclosing class or interface.
      Parameter:
      target - the content to which the documentation will be added

    • buildClassSignature

      protected void buildClassSignature(Content target)
      Build the signature of the current class.
      Parameter:
      target - the content to which the documentation will be added

    • buildClassDescription

      protected void buildClassDescription(Content target)
      Build the class description.
      Parameter:
      target - the content to which the documentation will be added

    • buildClassTagInfo

      protected void buildClassTagInfo(Content target)
      Build the tag information for the current class.
      Parameter:
      target - the content to which the documentation will be added

    • buildMemberSummary

      protected void buildMemberSummary(Content classContent) throws DocletException
      Build the member summary contents of the page.
      Parameter:
      classContent - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildMemberDetails

      protected void buildMemberDetails(Content classContent) throws DocletException
      Build the member details contents of the page.
      Parameter:
      classContent - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildEnumConstantsDetails

      protected void buildEnumConstantsDetails(Content detailsList) throws DocletException
      Build the enum constants documentation.
      Parameter:
      detailsList - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildFieldDetails

      protected void buildFieldDetails(Content detailsList) throws DocletException
      Build the field documentation.
      Parameter:
      detailsList - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildPropertyDetails

      public void buildPropertyDetails(Content detailsList) throws DocletException
      Build the property documentation.
      Parameter:
      detailsList - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildConstructorDetails

      protected void buildConstructorDetails(Content detailsList) throws DocletException
      Build the constructor documentation.
      Parameter:
      detailsList - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildMethodDetails

      protected void buildMethodDetails(Content detailsList) throws DocletException
      Build the method documentation.
      Parameter:
      detailsList - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildAnnotationTypeMemberDetails

      protected void buildAnnotationTypeMemberDetails(Content target) throws DocletException
      Build the annotation type optional member documentation.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem building the documentation