Package com.github.cukedoctor.spi

Interface HeaderRenderer

All Superinterfaces:

BaseRenderer

All Known Implementing Classes:

CukedoctorHeaderRenderer

public interface HeaderRenderer
extends BaseRenderer

Created by rmpestano on 27/04/20.

This renderer is responsible for generating the documentation header such as attributes

Method Summary

Modifier and Type	Method	Description
String	renderDocumentHeader(DocumentAttributes cukedoctorAttributes)	Deprecated. Use renderDocumentHeader(DocumentAttributes, CukedoctorDocumentBuilder) instead
default String	renderDocumentHeader(DocumentAttributes cukedoctorAttributes, CukedoctorDocumentBuilder documentBuilder)

Methods inherited from interface com.github.cukedoctor.renderer.BaseRenderer

setCukedoctorConfig, setDocumentAttributes, setDocumentBuilder, setI18n

Method Detail

renderDocumentHeader

@Deprecated
String renderDocumentHeader(DocumentAttributes cukedoctorAttributes)

Deprecated.

Use renderDocumentHeader(DocumentAttributes, CukedoctorDocumentBuilder) instead

Parameters:

cukedoctorAttributes - cukedoctor attributes

Returns:

the rendered String

renderDocumentHeader

default String renderDocumentHeader(DocumentAttributes cukedoctorAttributes,
                                    CukedoctorDocumentBuilder documentBuilder)