MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

PY-9795 Rearrange and group related methods in StructuredDocString interface

Browse Source
This commit is contained in:
Mikhail Golubev
2015-09-02 14:33:50 +03:00
parent 00a08306e9
commit b9ed603e75
1 changed files with 40 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
+40 -38
View File
@@ -34,9 +34,48 @@ public interface StructuredDocString {
@NotNull
String createParameterType(@NotNull String name, @NotNull String type);
String getSummary();
String getDescription();
String getSummary();
List<String> getParameters();
List<Substring> getParameterSubstrings();
@Nullable
String getParamType(@Nullable String paramName);
@Nullable
Substring getParamTypeSubstring(@Nullable String paramName);
@Nullable
String getParamDescription(@Nullable String paramName);
/**
* Keyword arguments are those arguments that usually don't exist in function signature,
* but are passed e.g. via {@code **kwargs} mechanism.
*/
List<String> getKeywordArguments();
List<Substring> getKeywordArgumentSubstrings();
// getKeywordArgumentType(name)
// getKeywordArgumentTypeString(name)
@Nullable
String getKeywordArgumentDescription(@Nullable String paramName);
@Nullable
String getReturnType();
@Nullable
Substring getReturnTypeSubstring();
@Nullable
String getReturnDescription();
List<String> getRaisedExceptions();
@Nullable
String getRaisedExceptionDescription(@Nullable String exceptionName);
// getAttributes
// getAttributeSubstrings
// getAttributeType(name)
// getAttributeTypeSubstring(name)
@Nullable
String getAttributeDescription();
// Tags related methods
@Nullable
Substring getTagValue(String... tagNames);
@@ -49,45 +88,8 @@ public interface StructuredDocString {
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);
}