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

Class RestDoclet

  • public class RestDoclet
extends java.lang.Object
    Doclet implementation for generating REST documentation. Main entry point for the Javadoc tool.

    • Constructor Summary

      Constructors 
      Constructor Description
      RestDoclet()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void closeFile​(java.io.PrintWriter writer)  
      static java.lang.String fileNameFor​(com.sun.javadoc.Type service)  
      static java.lang.String fileNameFor​(java.lang.String reference)  
      static com.sun.javadoc.LanguageVersion languageVersion()
      Needed by Javadoc engine to provide generic type information.
      static java.io.PrintWriter openFile​(java.lang.String fileName, java.lang.String title)  
      static int optionLength​(java.lang.String option)
      Needed by Javadoc engine.
      static boolean start​(com.sun.javadoc.RootDoc root)
      Main entry point for Javadoc.
      static boolean validOptions​(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)
      Needed by Javadoc engine.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RestDoclet

        public RestDoclet()

    • Method Detail

      • optionLength

        public static int optionLength​(java.lang.String option)
        Needed by Javadoc engine.

      • validOptions

        public static boolean validOptions​(java.lang.String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)
        Needed by Javadoc engine.

      • languageVersion

        public static com.sun.javadoc.LanguageVersion languageVersion()
        Needed by Javadoc engine to provide generic type information.

      • start

        public static boolean start​(com.sun.javadoc.RootDoc root)
        Main entry point for Javadoc.

      • fileNameFor

        public static java.lang.String fileNameFor​(com.sun.javadoc.Type service)

      • fileNameFor

        public static java.lang.String fileNameFor​(java.lang.String reference)

      • openFile

        public static java.io.PrintWriter openFile​(java.lang.String fileName,
                                           java.lang.String title)

      • closeFile

        public static void closeFile​(java.io.PrintWriter writer)