Module com.speedment.common.codegen
Package com.speedment.common.codegen.model.trait

Interface HasJavadocTags<T extends HasJavadocTags<T>>

  • Type Parameters:
    T - the extending type
    All Superinterfaces:
    HasImports<T>
    All Known Subinterfaces:
    Javadoc
    public interface HasJavadocTags<T extends HasJavadocTags<T>>
extends HasImports<T>
    A trait for models that contain JavadocTag components.
    Since:
    2.0
    Author:
    Emil Forslund

    • Method Detail

      • add

        default T add​(JavadocTag tag)
        Adds the specified JavadocTag to this model.
        Parameters:
        tag - the new child
        Returns:
        a reference to this

      • author

        default T author​(String name)
        Adds an DefaultJavadocTag.AUTHOR-tag with the specified value to this javadoc.
        Parameters:
        name - the name of the author
        Returns:
        a reference to this

      • returns

        default T returns​(String description)
        Adds an DefaultJavadocTag.RETURN-tag with the specified value to this javadoc.
        Parameters:
        description - description for the return tag
        Returns:
        a reference to this

      • since

        default T since​(String version)
        Adds an DefaultJavadocTag.SINCE-tag with the specified value to this javadoc.
        Parameters:
        version - version for the since tag
        Returns:
        a reference to this

      • see

        default T see​(Type type)
        Adds an DefaultJavadocTag.SEE-tag that references the specified Java type.
        Parameters:
        type - the type to reference in the see-tag
        Returns:
        a reference to this

      • param

        default T param​(String name,
                String description)
        Adds an DefaultJavadocTag.PARAM-tag with the specified value to this javadoc.
        Parameters:
        name - the name of the param
        description - the description (text) to use
        Returns:
        a reference to this

      • getTags

        List<JavadocTag> getTags()
        Returns a list of all documentation tags of this model.

        The list returned must be mutable for changes!

        Returns:
        the javadoc tags