DocsType (Gradle API 8.7)

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Named
```
public interface DocsType
extends Named
```
Attributes to qualify the type of documentation.
This attribute is usually found on variants that have the Category attribute valued at documentation.

Since:

5.6

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Named
  Named.Namer

Field Summary

Fields
Modifier and Type	Field	Description
`static Attribute<DocsType>`	`DOCS_TYPE_ATTRIBUTE`
`static java.lang.String`	`DOXYGEN`	The typical documentation for native APIs
`static java.lang.String`	`JAVADOC`	The typical documentation for Java APIs
`static java.lang.String`	`SAMPLES`	Samples illustrating how to use the software module
`static java.lang.String`	`SOURCES`	The source files of the module
`static java.lang.String`	`USER_MANUAL`	A user manual

Method Summary
- Methods inherited from interface org.gradle.api.Named
  getName

- Field Detail
  - DOCS_TYPE_ATTRIBUTE
```
static final Attribute<DocsType> DOCS_TYPE_ATTRIBUTE
```
  - JAVADOC
```
static final java.lang.String JAVADOC
```
    The typical documentation for Java APIs
    
    See Also:
    
    Constant Field Values
  - SOURCES
```
static final java.lang.String SOURCES
```
    The source files of the module
    
    See Also:
    
    Constant Field Values
  - USER_MANUAL
```
static final java.lang.String USER_MANUAL
```
    A user manual
    
    See Also:
    
    Constant Field Values
  - SAMPLES
```
static final java.lang.String SAMPLES
```
    Samples illustrating how to use the software module
    
    See Also:
    
    Constant Field Values
  - DOXYGEN
```
static final java.lang.String DOXYGEN
```
    The typical documentation for native APIs
    
    See Also:
    
    Constant Field Values

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method