Package io.vertx.docgen

Interface DocGenerator

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.lang.String getName()  
      void init​(javax.annotation.processing.ProcessingEnvironment env)
      Init the generator.
      java.lang.String renderSource​(javax.lang.model.element.ExecutableElement elt, java.lang.String source)
      Render the source code of the elt argument.
      java.lang.String resolveConstructorLink​(javax.lang.model.element.ExecutableElement elt)
      Resolve a constructor link.
      java.lang.String resolveFieldLink​(javax.lang.model.element.VariableElement elt)
      Resolve a field link.
      java.lang.String resolveLabel​(javax.lang.model.element.Element elt, java.lang.String defaultLabel)
      Resolve a label.
      java.lang.String resolveMethodLink​(javax.lang.model.element.ExecutableElement elt)
      Resolve a method link.
      default java.lang.String resolveRelativeFileName​(javax.lang.model.element.PackageElement docElt, java.lang.String relativeFileName)
      Resolve the relative file name of a document, the default implementation returns the relativeFileName parameter.
      java.lang.String resolveTypeLink​(javax.lang.model.element.TypeElement elt)
      Resolve a constructor link.

    • Method Detail

      • init

        void init​(javax.annotation.processing.ProcessingEnvironment env)
        Init the generator.
        Parameters:
        env - the processor environment

      • getName

        java.lang.String getName()
        Returns:
        the generator name

      • resolveRelativeFileName

        default java.lang.String resolveRelativeFileName​(javax.lang.model.element.PackageElement docElt,
                                                 java.lang.String relativeFileName)
        Resolve the relative file name of a document, the default implementation returns the relativeFileName parameter.
        Parameters:
        docElt - the doc element
        relativeFileName - the relative file name original value
        Returns:
        the relative file name

      • renderSource

        java.lang.String renderSource​(javax.lang.model.element.ExecutableElement elt,
                              java.lang.String source)
        Render the source code of the elt argument.
        Parameters:
        elt - the element to render
        source - the Java source of the element
        Returns:
        the rendered source

      • resolveTypeLink

        java.lang.String resolveTypeLink​(javax.lang.model.element.TypeElement elt)
        Resolve a constructor link.
        Parameters:
        elt - the element linked to
        Returns:
        the resolved http link or null if the link cannot be resolved

      • resolveConstructorLink

        java.lang.String resolveConstructorLink​(javax.lang.model.element.ExecutableElement elt)
        Resolve a constructor link.
        Parameters:
        elt - the element linked to
        Returns:
        the resolved http link or null if the link cannot be resolved

      • resolveMethodLink

        java.lang.String resolveMethodLink​(javax.lang.model.element.ExecutableElement elt)
        Resolve a method link.
        Parameters:
        elt - the element linked to
        Returns:
        the resolved http link or null if the link cannot be resolved

      • resolveFieldLink

        java.lang.String resolveFieldLink​(javax.lang.model.element.VariableElement elt)
        Resolve a field link.
        Parameters:
        elt - the element linked to
        Returns:
        the resolved http link or null if the link cannot be resolved

      • resolveLabel

        java.lang.String resolveLabel​(javax.lang.model.element.Element elt,
                              java.lang.String defaultLabel)
        Resolve a label.
        Parameters:
        elt - the labelled element
        defaultLabel - the default label
        Returns:
        the resolved label or null if a label cannot be resolved