@groovy.transform.CompileStatic class DocumentationCoreExtension extends Object
For registering files and outputs of a project as documentation
| Modifiers | Name | Description |
|---|---|---|
static String |
API_DOCS_NAVIGATION_METADATA_SUBDIR |
|
static String |
NAME |
| Constructor and description |
|---|
DocumentationCoreExtension
(Project project) |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
documents(TaskProvider<?> task, DocumentationType type)Adds the outputs of this task to the named outgoing configuration nif this is a multi-project. |
|
void |
documents(TaskProvider<?> task, DocumentationType type, Action<DocumentationEntity> docsMetadata)Adds the outputs of this task to the named outgoing configuration nif this is a multi-project. |
|
void |
documents(Provider<File> docs, TaskProvider<?> builtBy, DocumentationType type, Action<DocumentationEntity> docsMetadata)Provide a fire or directory which contains documents. |
|
void |
documents(Provider<File> docs, String builtBy, DocumentationType type, Action<DocumentationEntity> docsMetadata)Provide a document file or a directory which contains docs. |
|
void |
documents(String taskName, DocumentationType type)Adds the outputs of this task to the named outgoing configuration nif this is a multi-project. |
|
void |
documents(String taskName, DocumentationType type, Action<DocumentationEntity> docsMetadata)Adds the outputs of this task to the named outgoing configuration nif this is a multi-project. |
|
void |
documents(Provider<File> documents, DocumentationType type, String alias, Action<DocumentationEntity> docsMetadata)Adds the fixed documents at the provided location to the internal document collection. |
|
CopySpec |
incomingDocumentCopySpec(Provider<String> dest)Provides a copy specification for incoming documents. |
|
void |
projectsWithDocuments(Spec<String> filter)Aggregate document artifacts from some subprojects according to a filter |
Adds the outputs of this task to the named outgoing configuration nif this is a multi-project.
task - Task to be used.type - Type of documentation.Adds the outputs of this task to the named outgoing configuration nif this is a multi-project.
task - Task to be used.type - Type of documentation.docsMetadata - Provides additional information of the internal documentation.Provide a fire or directory which contains documents.
docs - Documents to be added.builtBy - Task responsible for generating content,type - Type of documentationdocsMetadata - Provides additional information of the internal documentation.Provide a document file or a directory which contains docs.
docs - Documents to be added.builtBy - Task name responsible for generating content,type - Type of documentationdocsMetadata - Provides additional information of the internal documentation.Adds the outputs of this task to the named outgoing configuration nif this is a multi-project.
taskName - Task to be used.type - Type of documentation.Adds the outputs of this task to the named outgoing configuration nif this is a multi-project.
taskName - Task to be used.type - Type of documentation.docsMetadata - Provides additional information of the internal documentation.Adds the fixed documents at the provided location to the internal document collection.
documents - Provider of documentstype - Type of documentationalias - Alias for this document or group of documents. Since these are not tied to a
task, we need to provide an alias to identify these documents. THe alias must not match
any existing task name.docsMetadata - Provides additional information of the internal documentation.Provides a copy specification for incoming documents.
dest - Target subfolderAggregate document artifacts from some subprojects according to a filter This needs to be set in the root project otherwise document artifacts will not be collected.
filter - This is passed a project path. It should return true if a subproject's documentation
should be consumed.