Package com.github.cukedoctor

Class Cukedoctor

java.lang.Object

com.github.cukedoctor.Cukedoctor

public class Cukedoctor
extends Object

Created by pestano on 10/06/15.

Factory of Cukedoctor converter

Constructor Summary

Constructors

Constructor	Description
Cukedoctor()

Method Summary

Modifier and Type	Method	Description
static CukedoctorConfig	getDefaultConfig()
static DocumentAttributes	getDefaultDocumentAttributes()
static CukedoctorConverter	instance(List<Feature> features)
static CukedoctorConverter	instance(List<Feature> features, CukedoctorDocumentBuilder docBuilder)
static CukedoctorConverter	instance(List<Feature> features, DocumentAttributes attrs)
static CukedoctorConverter	instance(List<Feature> features, DocumentAttributes attrs, CukedoctorConfig cukedoctorConfig)
static CukedoctorConverter	instance(List<Feature> features, DocumentAttributes attrs, CukedoctorConfig cukedoctorConfig, CukedoctorDocumentBuilder docBuilder)

Methods inherited from class java.lang.Object

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

Constructor Detail

Cukedoctor

public Cukedoctor()

Method Detail

instance

public static CukedoctorConverter instance(List<Feature> features,
                                           DocumentAttributes attrs,
                                           CukedoctorConfig cukedoctorConfig,
                                           CukedoctorDocumentBuilder docBuilder)

Parameters:

features - used to generate the documentation

attrs - document attributes

cukedoctorConfig - Cukedoctor configuration

docBuilder - helper for building AsciiDoc documents with Cukedoctor conventions

Returns:

a Cukedoctor converter instance

instance

public static CukedoctorConverter instance(List<Feature> features,
                                           DocumentAttributes attrs,
                                           CukedoctorConfig cukedoctorConfig)

Parameters:

features - used to generate the documentation

attrs - document attributes

cukedoctorConfig - Cukedoctor configuration

Returns:

a Cukedoctor converter instance

instance

public static CukedoctorConverter instance(List<Feature> features,
                                           DocumentAttributes attrs)

Parameters:

features - used to generate the documentation

attrs - document attributes

Returns:

a Cukedoctor converter instance

instance

public static CukedoctorConverter instance(List<Feature> features,
                                           CukedoctorDocumentBuilder docBuilder)

Parameters:

features - used to generate the documentation

docBuilder - helper for building AsciiDoc documents with Cukedoctor conventions

Returns:

a Cukedoctor converter instance

instance

public static CukedoctorConverter instance(List<Feature> features)

Parameters:

features - used to generate the documentation

Returns:

a Cukedoctor converter instance

getDefaultDocumentAttributes

public static DocumentAttributes getDefaultDocumentAttributes()

getDefaultConfig

public static CukedoctorConfig getDefaultConfig()