blob: 808ec477e89ac630ef59bdbf38aca944deb7aa26 (
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
|
/*
* 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.psi;
import com.jetbrains.python.toolbox.Substring;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
/**
* @author vlan
*/
public interface StructuredDocString {
/**
* Creates parameter type documentation specific for certain doct type
* @param name param name
* @param type param type
* @return text to add to docsting
*/
@NotNull
String createParameterType(@NotNull String name, @NotNull String type);
String getDescription();
String getSummary();
@Nullable
Substring getTagValue(String... tagNames);
@Nullable
Substring getTagValue(String tagName, @NotNull String argName);
@Nullable
Substring getTagValue(String[] tagNames, @NotNull String argName);
List<Substring> getTagArguments(String... tagNames);
List<Substring> getParameterSubstrings();
@Nullable
Substring getParamByNameAndKind(@NotNull String name, String kind);
List<String> getParameters();
List<String> getKeywordArguments();
@Nullable
String getReturnType();
@Nullable
String getReturnDescription();
@Nullable
String getParamType(@Nullable String paramName);
@Nullable
String getParamDescription(@Nullable String paramName);
@Nullable
String getKeywordArgumentDescription(@Nullable String paramName);
List<String> getRaisedExceptions();
@Nullable
String getRaisedExceptionDescription(@Nullable String exceptionName);
@Nullable
String getAttributeDescription();
List<String> getAdditionalTags();
List<Substring> getKeywordArgumentSubstrings();
@Nullable
Substring getReturnTypeSubstring();
@Nullable
Substring getParamTypeSubstring(@Nullable String paramName);
}
|
