AntoraExtension (ysf-documentation-antora-plugin 1.0.0 API)

org.ysb33r.ysf.projects.antora.AntoraExtension

@groovy.transform.CompileStatic
class AntoraExtension
extends Object

Configures Antora document generation.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`AntoraExtension.CopyFilter`	Defines a copy filter.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`API_DOCS_SECTION`
`static String`	`CHANGELOG_SECTION`
`static String`	`LEGACY_DOCS_SECTION`
`static String`	`NAME`

Properties Summary

Properties
Type	Name and description
`AntoraExtension.CopyFilter`	`antoraSourceFilter` A filter for copying unmodified Antora sources.
`AntoraExtension.CopyFilter`	`antoraYmlFilter` A filter for copying `antora.yml`
`Provider<String>`	`componentName`
`Provider<String>`	`rootStartDocument`
`Provider<File>`	`sourceDirectory`
`Provider<String>`	`title`

Constructor Summary

Constructors
Constructor and description
`AntoraExtension (Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Provider<String>`	`getComponentName()` The name of the Antora component.
	`Provider<java.util.List<java.util.regex.Pattern>>`	`getIgnoreWarnings()` Antora warnings to ignore.
	`Provider<Boolean>`	`getPreserveLegacyDocumentation()` Whether legacy documentation should be migrated if found.
	`Provider<java.util.List<String>>`	`getPreservedLegacyVersions()` Returns the list of legacy versions to be preserved.
	`Provider<String>`	`getRootStartDocument()` The name of the document in `ROOT/pages` that shoudl be used as the starting point.
	`Provider<java.util.List<String>>`	`getScriptExtensions()` List of Antora script extensions.
	`Provider<File>`	`getSourceDirectory()` The directory where Antora sources are to be found.
	`Provider<String>`	`getTitle()` Documentation title for the project
	`void`	`ignoreWarnings(java.util.List<String> patterns)` When considering Antora warnings as failures, ignore these warnings.
	`void`	`ignoreWarnings(String[] patterns)` When considering Antora warnings as failures, ignore these warnings.
	`void`	`scriptExtension(String path)` Adds an Antora script extension
	`void`	`setComponentName(Object name)` Sets the component name.
	`void`	`setPreserveLegacyDocumentation(boolean value)` Sets whether legacy documentation should be preserved.
	`void`	`setRootStartDocument(Object name)` Set the starting document.
	`void`	`setSourceDirectory(Object dir)` Set the Antora source directory.
	`void`	`setTitle(Object t)` Sets the title of the project.

Inherited Methods Summary

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

- Field Detail
  - public static final String API_DOCS_SECTION
  - public static final String CHANGELOG_SECTION
  - public static final String LEGACY_DOCS_SECTION
  - public static final String NAME
- Property Detail
  - final AntoraExtension.CopyFilter antoraSourceFilter
    
    A filter for copying unmodified Antora sources.
  - final AntoraExtension.CopyFilter antoraYmlFilter
    
    A filter for copying antora.yml
  - Provider<String> componentName
  - Provider<String> rootStartDocument
  - Provider<File> sourceDirectory
  - Provider<String> title
- Constructor Detail
  - @SuppressWarnings(value: UnnecessaryCast) AntoraExtension(Project project)
- Method Detail
  - Provider<String> getComponentName()
    
    The name of the Antora component.
    This is the name entry in the antora.yml file. It is also used to calcualte the start_page in the Antora playbook.
    
    Returns:
    Component name
  - Provider<java.util.List<java.util.regex.Pattern>> getIgnoreWarnings()
    
    Antora warnings to ignore.
    Returns:
    Provide to a list of patterns.
  - Provider<Boolean> getPreserveLegacyDocumentation()
    
    Whether legacy documentation should be migrated if found.
    Returns:
    true if legacy documentation should be preserved.
  - Provider<java.util.List<String>> getPreservedLegacyVersions()
    
    Returns the list of legacy versions to be preserved.
    Returns:
    The list of versions. If legacy versions are not preserved, this returns an empty list.
  - Provider<String> getRootStartDocument()
    
    The name of the document in ROOT/pages that shoudl be used as the starting point.
    The default is index.adoc.
    
    Returns:
    Start document name
  - Provider<java.util.List<String>> getScriptExtensions()
    
    List of Antora script extensions.
    Returns:
    Provider to a list of subpaths.
  - Provider<File> getSourceDirectory()
    
    The directory where Antora sources are to be found. Files in this directory are preprocessed and then placed in a working directory before processed by Antora.
    Returns:
    Directory
  - Provider<String> getTitle()
    
    Documentation title for the project
    Returns:
    Title provider
  - void ignoreWarnings(java.util.List<String> patterns)
    
    When considering Antora warnings as failures, ignore these warnings.
    Parameters:
    patterns - Regex patterns
  - void ignoreWarnings(String[] patterns)
    
    When considering Antora warnings as failures, ignore these warnings.
    Parameters:
    patterns - Regex patterns
  - void scriptExtension(String path)
    
    Adds an Antora script extension
    Parameters:
    path - A path below the script directory in the Antora source directory.
    Since:
    1.0
  - void setComponentName(Object name)
    
    Sets the component name.
    Parameters:
    name - Name of component
  - void setPreserveLegacyDocumentation(boolean value)
    
    Sets whether legacy documentation should be preserved.
    If set to true then docs/legacy-versions.txt should exist. This file can be created by migrating the older docs/landingPage/display-versions.txt. The default is to preserve legacy documentation
    
    Parameters:
    value - true to preserve legacy docs.
  - void setRootStartDocument(Object name)
    
    Set the starting document.
    Parameters:
    name - Name of file inside ROOT/pages.
  - void setSourceDirectory(Object dir)
    
    Set the Antora source directory.
    Parameters:
    dir - Directory where authored sources are to be found.
  - void setTitle(Object t)
    
    Sets the title of the project.
    Parameters:
    t - Title

Groovy Documentation

[Groovy] Class AntoraExtension

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String API_DOCS_SECTION

public static final String CHANGELOG_SECTION

public static final String LEGACY_DOCS_SECTION

public static final String NAME

Property Detail

final AntoraExtension.CopyFilter antoraSourceFilter

final AntoraExtension.CopyFilter antoraYmlFilter

Provider<String> componentName

Provider<String> rootStartDocument

Provider<File> sourceDirectory

Provider<String> title

Constructor Detail

@SuppressWarnings(value: UnnecessaryCast) AntoraExtension(Project project)

Method Detail

Provider<String> getComponentName()

Provider<java.util.List<java.util.regex.Pattern>> getIgnoreWarnings()

Provider<Boolean> getPreserveLegacyDocumentation()

Provider<java.util.List<String>> getPreservedLegacyVersions()

Provider<String> getRootStartDocument()

Provider<java.util.List<String>> getScriptExtensions()

Provider<File> getSourceDirectory()

Provider<String> getTitle()

void ignoreWarnings(java.util.List<String> patterns)

void ignoreWarnings(String[] patterns)

void scriptExtension(String path)

void setComponentName(Object name)

void setPreserveLegacyDocumentation(boolean value)

void setRootStartDocument(Object name)

void setSourceDirectory(Object dir)

void setTitle(Object t)