Class NoAuthorJavaDocRenderer

  • All Implemented Interfaces:
    JavaDocRenderer

    public class NoAuthorJavaDocRenderer
    extends DefaultJavaDocRenderer

    Default JavaDocRenderer implementation which provides a plain JavaDocData rendering, while skipping output from the author tag, on the form:

         [JavaDoc comment]
         (tag1): [tag1 value]
         (tag2): [tag2 value]
     
    Since:
    2.3
    • Field Detail

      • AUTHOR_KEY

        private static final java.lang.String AUTHOR_KEY
        The author key.
        See Also:
        Constant Field Values
    • Constructor Detail

      • NoAuthorJavaDocRenderer

        public NoAuthorJavaDocRenderer()
    • Method Detail

      • renderJavaDocTag

        protected java.lang.String renderJavaDocTag​(java.lang.String name,
                                                    java.lang.String value,
                                                    SortableLocation location)
        Override this method to yield another
        Overrides:
        renderJavaDocTag in class DefaultJavaDocRenderer
        Parameters:
        name - The name of a JavaDoc tag.
        value - The value of a JavaDoc tag.
        location - the SortableLocation where the JavaDocData was harvested. Never null.
        Returns:
        The XSD documentation for the supplied JavaDoc tag.