blob: b1a0802c93eeb1a3115117f6fa3439cfa7fb9b02 (
plain)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.docgen.skylark;
import com.google.devtools.build.lib.syntax.BaseFunction;
import com.google.devtools.build.lib.syntax.SkylarkSignature;
import com.google.devtools.build.lib.syntax.SkylarkSignature.Param;
import java.util.ArrayList;
import java.util.List;
/**
* A class representing a Skylark built-in object or method.
*/
public final class SkylarkBuiltinMethodDoc extends SkylarkMethodDoc {
private final SkylarkModuleDoc module;
private final SkylarkSignature annotation;
private final Class<?> fieldClass;
private List<SkylarkParamDoc> params;
public SkylarkBuiltinMethodDoc(SkylarkModuleDoc module, SkylarkSignature annotation,
Class<?> fieldClass) {
this.module = module;
this.annotation = annotation;
this.fieldClass = fieldClass;
this.params = new ArrayList<>();
processParams();
}
public SkylarkSignature getAnnotation() {
return annotation;
}
@Override
public boolean documented() {
return annotation.documented();
}
@Override
public String getName() {
return annotation.name();
}
@Override
public String getDocumentation() {
return annotation.doc();
}
/**
* Returns a string representing the method signature with links to the types if
* available.
*
* <p>If the built-in method is a function, the construct the method signature. Otherwise,
* return a string containing the return type of the method.
*/
@Override
public String getSignature() {
if (BaseFunction.class.isAssignableFrom(fieldClass)) {
return getSignature(module.getName(), annotation);
}
if (!annotation.returnType().equals(Object.class)) {
return getTypeAnchor(annotation.returnType());
}
return "";
}
@Override
public List<SkylarkParamDoc> getParams() {
return params;
}
private void processParams() {
processParams(adjustedMandatoryPositionals(annotation));
processParams(annotation.optionalPositionals());
processParams(annotation.optionalNamedOnly());
processParams(annotation.mandatoryNamedOnly());
processParams(annotation.extraPositionals());
processParams(annotation.extraKeywords());
}
private void processParams(Param[] params) {
for (Param param : params) {
this.params.add(new SkylarkParamDoc(this, param));
}
}
}
|
