-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
DocsType.java
55 lines (47 loc) · 1.49 KB
/
DocsType.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.attributes;
import org.gradle.api.Named;
/**
* Attributes to qualify the type of documentation.
* <p>
* This attribute is usually found on variants that have the {@link Category} attribute valued at {@link Category#DOCUMENTATION documentation}.
*
* @since 5.6
*/
public interface DocsType extends Named {
Attribute<DocsType> DOCS_TYPE_ATTRIBUTE = Attribute.of("org.gradle.docstype", DocsType.class);
/**
* The typical documentation for Java APIs
*/
String JAVADOC = "javadoc";
/**
* The source files of the module
*/
String SOURCES = "sources";
/**
* A user manual
*/
String USER_MANUAL = "user-manual";
/**
* Samples illustrating how to use the software module
*/
String SAMPLES = "samples";
/**
* The typical documentation for native APIs
*/
String DOXYGEN = "doxygen";
}