Package org.ysb33r.ysf.projects.core.documentation

Interface DocumentationEntity

public interface DocumentationEntity

Describes properties project documentation documentation.

Method Summary

Modifier and Type	Method	Description
void	setEntryPoint(String ep)	Sets the entrypoint for a set of internal documentation
void	setEntryPoint(org.gradle.api.provider.Provider<String> ep)	Sets the entrypoint in a lazy way.
void	setSection(String section)	Set a different section for the documentation set.
void	setTitleProvider(Callable<String> title)	Sets the method that will provide a title for the specific set of internal documentation.
void	setTitleProvider(org.gradle.api.provider.Provider<String> title)	Sets the method that will provide a title for the specific set of internal documentation.

Method Details

setEntryPoint

void setEntryPoint(String ep)

Sets the entrypoint for a set of internal documentation

Parameters:

ep - Entrypoint relative path. Could be something as simple as index.html

setEntryPoint

void setEntryPoint(org.gradle.api.provider.Provider<String> ep)

Sets the entrypoint in a lazy way.

Parameters:

ep - Provider to an entrypoint

setTitleProvider

void setTitleProvider(Callable<String> title)

Sets the method that will provide a title for the specific set of internal documentation.

Parameters:

title - Title provider.

setTitleProvider

void setTitleProvider(org.gradle.api.provider.Provider<String> title)

Sets the method that will provide a title for the specific set of internal documentation.

Parameters:

title - Title provider.

setSection

void setSection(String section)

Set a different section for the documentation set.

Parameters:

section - Section name