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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
* Copyright 2000-2013 JetBrains s.r.o.
*
* 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.jetbrains.python.documentation;
import com.jetbrains.python.toolbox.Substring;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collections;
import java.util.List;
/**
* @author yole
*/
public class SphinxDocString extends StructuredDocStringBase {
public static String[] KEYWORD_ARGUMENT_TAGS = new String[] { "keyword", "key" };
public static String[] ALL_TAGS = new String[] { ":param", ":parameter", ":arg", ":argument", ":keyword", ":key",
":type", ":raise", ":raises", ":var", ":cvar", ":ivar",
":return", ":returns", ":rtype", ":except", ":exception" };
public SphinxDocString(@NotNull String docstringText) {
super(docstringText, ":");
}
@Nullable
protected static String concatTrimmedLines(@Nullable Substring s) {
return s != null ? s.concatTrimmedLines(" ") : null;
}
@Override
public List<String> getParameters() {
return toUniqueStrings(getParameterSubstrings());
}
@Override
public List<String> getKeywordArguments() {
return toUniqueStrings(getKeywordArgumentSubstrings());
}
@Nullable
@Override
public String getKeywordArgumentDescription(@Nullable String paramName) {
if (paramName == null) {
return null;
}
return concatTrimmedLines(getTagValue(KEYWORD_ARGUMENT_TAGS, paramName));
}
@Override
public String getReturnType() {
return concatTrimmedLines(getReturnTypeSubstring());
}
@Override
public String getParamType(@Nullable String paramName) {
return concatTrimmedLines(getParamTypeSubstring(paramName));
}
@Nullable
@Override
public String getParamDescription(@Nullable String paramName) {
return paramName != null ? concatTrimmedLines(getTagValue("param", paramName)) : null;
}
@Override
public String getReturnDescription() {
return concatTrimmedLines(getTagValue(RETURN_TAGS));
}
@Override
public List<String> getRaisedExceptions() {
return toUniqueStrings(getTagArguments(RAISES_TAGS));
}
@Nullable
@Override
public String getRaisedExceptionDescription(@Nullable String exceptionName) {
if (exceptionName == null) {
return null;
}
return concatTrimmedLines(getTagValue(RAISES_TAGS, exceptionName));
}
@Override
public String getAttributeDescription() {
return concatTrimmedLines(getTagValue(VARIABLE_TAGS));
}
@Override
public List<String> getAdditionalTags() {
return Collections.emptyList();
}
@Override
public List<Substring> getKeywordArgumentSubstrings() {
return getTagArguments(KEYWORD_ARGUMENT_TAGS);
}
@Override
public Substring getReturnTypeSubstring() {
return getTagValue("rtype");
}
@Override
public Substring getParamTypeSubstring(@Nullable String paramName) {
return paramName == null ? getTagValue("type") : getTagValue("type", paramName);
}
@Override
public String getDescription() {
return myDescription.replaceAll("\n", "<br/>");
}
}
|
