summaryrefslogtreecommitdiff
path: root/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
diff options
context:
space:
mode:
Diffstat (limited to 'python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java')
-rw-r--r--python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java9
1 files changed, 9 insertions, 0 deletions
diff --git a/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java b/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
index fa8881062ac3..808ec477e89a 100644
--- a/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
+++ b/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
@@ -25,6 +25,15 @@ 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();