water.api

Class DocGen

java.lang.Object

water.api.DocGen

Direct Known Subclasses:

DocGen.HTML

public abstract class DocGen
extends java.lang.Object

Auto-gen doc support, for JSON and REST API docs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocGen.FieldDoc
static class	DocGen.HTML

Field Summary

Fields

Modifier and Type	Field and Description
static DocGen.HTML	HTML
static water.api.DocGen.ReST	ReST

Constructor Summary

Constructors

Constructor and Description
DocGen()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.StringBuilder	bodyHead(java.lang.StringBuilder sb)
abstract java.lang.StringBuilder	bodyTail(java.lang.StringBuilder sb)
abstract java.lang.String	bold(java.lang.String s)
static void	createFile(java.lang.String fileName, java.lang.String content)
static void	createReSTFilesInCwd()
abstract java.lang.StringBuilder	escape(java.lang.StringBuilder sb, java.lang.String s)
java.lang.String	genHelp(Request R)
abstract java.lang.StringBuilder	listBullet(java.lang.StringBuilder sb, java.lang.String s, java.lang.String body, int d)
abstract java.lang.StringBuilder	listHead(java.lang.StringBuilder sb)
abstract java.lang.StringBuilder	listTail(java.lang.StringBuilder sb)
static void	main(java.lang.String[] args) The main method launched in the H2O environment and generating documentation.
java.lang.StringBuilder	paragraph(java.lang.StringBuilder sb, java.lang.String s)
abstract java.lang.StringBuilder	paraHead(java.lang.StringBuilder sb)
abstract java.lang.StringBuilder	paraTail(java.lang.StringBuilder sb)
abstract java.lang.StringBuilder	section(java.lang.StringBuilder sb, java.lang.String t)
abstract java.lang.StringBuilder	title(java.lang.StringBuilder sb, java.lang.String t)

Methods inherited from class java.lang.Object

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

Field Detail

HTML

public static final DocGen.HTML HTML

ReST

public static final water.api.DocGen.ReST ReST

Constructor Detail

DocGen

public DocGen()

Method Detail

createFile

public static void createFile(java.lang.String fileName,
              java.lang.String content)

createReSTFilesInCwd

public static void createReSTFilesInCwd()

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

The main method launched in the H2O environment and generating documentation.

Throws:

java.lang.Exception

escape

public abstract java.lang.StringBuilder escape(java.lang.StringBuilder sb,
                             java.lang.String s)

bodyHead

public abstract java.lang.StringBuilder bodyHead(java.lang.StringBuilder sb)

bodyTail

public abstract java.lang.StringBuilder bodyTail(java.lang.StringBuilder sb)

title

public abstract java.lang.StringBuilder title(java.lang.StringBuilder sb,
                            java.lang.String t)

section

public abstract java.lang.StringBuilder section(java.lang.StringBuilder sb,
                              java.lang.String t)

listHead

public abstract java.lang.StringBuilder listHead(java.lang.StringBuilder sb)

listBullet

public abstract java.lang.StringBuilder listBullet(java.lang.StringBuilder sb,
                                 java.lang.String s,
                                 java.lang.String body,
                                 int d)

listTail

public abstract java.lang.StringBuilder listTail(java.lang.StringBuilder sb)

bold

public abstract java.lang.String bold(java.lang.String s)

paraHead

public abstract java.lang.StringBuilder paraHead(java.lang.StringBuilder sb)

paraTail

public abstract java.lang.StringBuilder paraTail(java.lang.StringBuilder sb)

paragraph

public java.lang.StringBuilder paragraph(java.lang.StringBuilder sb,
                                java.lang.String s)

genHelp

public java.lang.String genHelp(Request R)