@groovy.transform.CompileStatic @groovy.util.logging.Slf4j class InternalDocumentsUtils extends Object
` Common methods for declaring and configuring internal documents.
| Modifiers | Name | Description |
|---|---|---|
static String |
API_DOCS_NAVIGATION_METADATA_SUBDIR |
| Constructor and description |
|---|
InternalDocumentsUtils
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
static void |
addStaticFilesAsDocumentProvider(Project project, Provider<File> documents, String alias, DocumentationType type, Action<DocumentationEntity> docsMetadata)Adds a source of documentation which is fixed and not provided by a task. |
|
static void |
addTaskAsDocumentProvider(Project project, TaskProvider<?> task, DocumentationType type, Action<DocumentationEntity> docsMetadata)Adds a task a a provider of documentation. |
|
static void |
addTaskAsDocumentProvider(Project project, Provider<File> documents, TaskProvider<?> task, DocumentationType type, Action<DocumentationEntity> docsMetadata)Adds a source of documentation. |
Adds a source of documentation which is fixed and not provided by a task.
project - Associated projectProvider - of a file or directory.alias - Alias for the document grouptype - Documentation typedocsMetadata - A configurator that provides more context for the documentation.Adds a task a a provider of documentation.
project - Associated projecttask - Provider to a task. This assumes that the task has a single output directory that
will be used to collect the outputs.type - Documentation typedocsMetadata - A configurator that provides more context for the documentation.Adds a source of documentation.
project - Associated projectProvider - of a file or directory.task - Provider to a task responsible for building the contenttype - Documentation typedocsMetadata - A configurator that provides more context for the documentation.