Package com.xebialabs.gradle.documentation.restdoc.doclet

Class RestdocWriter

  • Direct Known Subclasses:
    OverviewWriter, RestServiceWriter
    public class RestdocWriter
extends com.xebialabs.commons.html.HtmlWriter
    HtmlWriter with convenience methods for writing REST documentation.

    • Constructor Summary

      Constructors 
      Constructor Description
      RestdocWriter​(java.io.PrintWriter writer)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.String asReference​(com.sun.javadoc.Type type)  
      protected java.lang.String asText​(com.sun.javadoc.Tag[] tags)  
      protected java.lang.String asText​(com.sun.javadoc.Type type)  
      static java.lang.String firstWord​(com.sun.javadoc.Tag tag)  
      protected com.sun.javadoc.Tag[] getDeprecatedTags​(com.sun.javadoc.Doc service)  
      java.util.List<com.sun.javadoc.Type> getParametrizedTypes​(com.sun.javadoc.Type type)  
      protected com.sun.javadoc.Tag[] getTags​(com.sun.javadoc.Doc service)  
      protected java.lang.Object renderType​(com.sun.javadoc.Type type)  
      static java.lang.String restOfSentence​(com.sun.javadoc.Tag tag)  

      • Methods inherited from class com.xebialabs.commons.html.HtmlWriter

        anchor, body, bold, br, code, definitionList, div, element, getWriter, h1, h2, h3, h4, head, hr, html, img, italic, link, linkCss, p, row, rowHeader, span, table, td, th, title, tr, wrap, write

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RestdocWriter

        public RestdocWriter​(java.io.PrintWriter writer)

    • Method Detail

      • asText

        protected java.lang.String asText​(com.sun.javadoc.Tag[] tags)

      • asText

        protected java.lang.String asText​(com.sun.javadoc.Type type)

      • firstWord

        public static java.lang.String firstWord​(com.sun.javadoc.Tag tag)

      • restOfSentence

        public static java.lang.String restOfSentence​(com.sun.javadoc.Tag tag)

      • asReference

        protected java.lang.String asReference​(com.sun.javadoc.Type type)

      • getParametrizedTypes

        public java.util.List<com.sun.javadoc.Type> getParametrizedTypes​(com.sun.javadoc.Type type)

      • renderType

        protected java.lang.Object renderType​(com.sun.javadoc.Type type)

      • getDeprecatedTags

        protected com.sun.javadoc.Tag[] getDeprecatedTags​(com.sun.javadoc.Doc service)

      • getTags

        protected com.sun.javadoc.Tag[] getTags​(com.sun.javadoc.Doc service)