Class AbstractJHtmlComment

    • Constructor Detail

      • AbstractJHtmlComment

        AbstractJHtmlComment()
    • Method Detail

      • block

        public JHtmlComment block()
        Description copied from interface: JComment
        Add a comment sub-block at this location. The block has no visual representation but allows text to be inserted at the point of the block even after more content was appended after it.
        Specified by:
        block in interface JComment
        Specified by:
        block in interface JHtmlComment
        Overrides:
        block in class AbstractJComment
        Returns:
        the comment sub-block
      • typeName

        public JHtmlComment typeName​(JType type)
        Description copied from interface: JComment
        Add a type name to the end of this comment. If the type is imported, it will emit as a simple name, otherwise it will emit as a qualified name.
        Specified by:
        typeName in interface JComment
        Specified by:
        typeName in interface JHtmlComment
        Overrides:
        typeName in class AbstractJComment
        Parameters:
        type - the type name to add
        Returns:
        this comment
      • text

        public JHtmlComment text​(java.lang.String text)
        Description copied from interface: JComment
        Add some text to the end of this comment. No formatting or line breaks are inserted.
        Specified by:
        text in interface JComment
        Specified by:
        text in interface JHtmlComment
        Overrides:
        text in class AbstractJComment
        Parameters:
        text - the text to add
        Returns:
        this comment
      • value

        public JHtmlComment value​(JType type,
                                  java.lang.String fieldName)
        Description copied from interface: JHtmlComment
        Add a @value inline tag.
        Specified by:
        value in interface JHtmlComment
        Parameters:
        type - the value type
        fieldName - the value field name
        Returns:
        this HTML comment
      • htmlLink

        public JHtmlTag htmlLink​(java.lang.String url)
        Description copied from interface: JHtmlComment
        Add an HTML link (<a> tag).
        Specified by:
        htmlLink in interface JHtmlComment
        Parameters:
        url - the URL to link to
        Returns:
        the link tag body
      • htmlTag

        public JHtmlTag htmlTag​(java.lang.String tag,
                                boolean newLine)
        Description copied from interface: JHtmlComment
        Add an HTML tag. The given tag should be a valid HTML 4 or 5 tag.
        Specified by:
        htmlTag in interface JHtmlComment
        Parameters:
        tag - the HTML tag
        newLine - true to add a newline after the opening tag and before the closing tag
        Returns:
        the tag body
      • preformattedCode

        public JComment preformattedCode()
        Description copied from interface: JHtmlComment
        Add an inline @code tag within a <pre></pre> block.
        Specified by:
        preformattedCode in interface JHtmlComment
        Returns:
        the preformatted code block content