DefaultDocumentationEntity (ysf-core-plugin 0.2.4 API)

org.ysb33r.ysf.projects.core.internal.documentation.DefaultDocumentationEntity

All Implemented Interfaces and Traits:: DocumentationEntity

@groovy.transform.CompileStatic
@groovy.transform.ToString(includeNames: true, includeFields: true, includes: name,projectPath)
class DefaultDocumentationEntity
extends Object
implements DocumentationEntity

Working class for defining internal documentation

Properties Summary

Properties
Type	Name and description
`String`	`entryPoint`
`String`	`section`
`DocumentationType`	`type`

Constructor Summary

Constructors
Constructor and description
`DefaultDocumentationEntity (Project project, TaskProvider<?> task, DocumentationType type)`
`DefaultDocumentationEntity (Project project, String alias, DocumentationType type)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getEntryPoint()` The entrypoint for the specific documentation
	`String`	`getNavsEntryRelativePath()` Get navigation relative path for placing a description of the Navigation entry
	`String`	`getPrivatePath()` A subpath that distinguised these documents from all others
	`String`	`getRelativePath()` Get relative path for placing documentation.
	`String`	`getSection()` Name of section.
	`String`	`getTitle()` Reads the title of the documentation
	`void`	`setEntryPoint(String ep)` Sets the entrypoint for a set of internal documentation.
	`void`	`setEntryPoint(Provider<String> ep)` Sets the entrypoint in a lazy way.
	`void`	`setSection(String section)` Set a different section for the documentation set.
	`void`	`setTitleProvider(java.util.concurrent.Callable<String> title)` Sets the method that will provide a title for the specific set of internal documentation.
	`void`	`setTitleProvider(Provider<String> title)` Sets the method that will provide a title for the specific set of internal documentation.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Property Detail
  - String entryPoint
  - String section
  - final DocumentationType type
- Constructor Detail
  - DefaultDocumentationEntity(Project project, TaskProvider<?> task, DocumentationType type)
  - @SuppressWarnings(value: DuplicateStringLiteral) DefaultDocumentationEntity(Project project, String alias, DocumentationType type)
- Method Detail
  - String getEntryPoint()
    
    The entrypoint for the specific documentation
    code:
    null).
    
    Returns:
    Entrypoint (or
  - String getNavsEntryRelativePath()
    
    Get navigation relative path for placing a description of the Navigation entry
    Returns:
    Relative path
  - String getPrivatePath()
    
    A subpath that distinguised these documents from all others
    Returns:
    Subpath.
  - String getRelativePath()
    
    Get relative path for placing documentation.
    Returns:
    Relative path
  - String getSection()
    
    Name of section.
    Returns:
    OPtional name of section. Can be null
  - String getTitle()
    
    Reads the title of the documentation
    Returns:
    Title
  - @Override 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
  - @Override void setEntryPoint(Provider<String> ep)
    
    Sets the entrypoint in a lazy way.
    Parameters:
    ep - Provider to an entrypoint
  - @Override void setSection(String section)
    
    Set a different section for the documentation set.
    Parameters:
    section - Section name
  - @Override void setTitleProvider(java.util.concurrent.Callable<String> title)
    
    Sets the method that will provide a title for the specific set of internal documentation.
    Parameters:
    title - Title provider.
  - @Override void setTitleProvider(Provider<String> title)
    
    Sets the method that will provide a title for the specific set of internal documentation.
    Parameters:
    title - Title provider.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class DefaultDocumentationEntity

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String entryPoint

String section

final DocumentationType type

Constructor Detail

DefaultDocumentationEntity(Project project, TaskProvider<?> task, DocumentationType type)

@SuppressWarnings(value: DuplicateStringLiteral) DefaultDocumentationEntity(Project project, String alias, DocumentationType type)

Method Detail

String getEntryPoint()

String getNavsEntryRelativePath()

String getPrivatePath()

String getRelativePath()

String getSection()

String getTitle()

@Override void setEntryPoint(String ep)

@Override void setEntryPoint(Provider<String> ep)

@Override void setSection(String section)

@Override void setTitleProvider(java.util.concurrent.Callable<String> title)

@Override void setTitleProvider(Provider<String> title)