aboutsummaryrefslogtreecommitdiff
path: root/src/Languages
diff options
context:
space:
mode:
authorDmitry Jemerov <yole@jetbrains.com>2015-10-27 17:12:31 +0100
committerDmitry Jemerov <yole@jetbrains.com>2015-10-29 11:57:20 +0100
commit3faa3f2d1c7ca33ad8d98bc6c562e4fe6977225f (patch)
treeab52ce7c62c485f892e12c05e0c619c44f410cf6 /src/Languages
parent44498ab2912d1156ad9d6549353251c9220af888 (diff)
downloaddokka-3faa3f2d1c7ca33ad8d98bc6c562e4fe6977225f.tar.gz
dokka-3faa3f2d1c7ca33ad8d98bc6c562e4fe6977225f.tar.bz2
dokka-3faa3f2d1c7ca33ad8d98bc6c562e4fe6977225f.zip
summarize signatures for overloaded stdlib functions
Diffstat (limited to 'src/Languages')
-rw-r--r--src/Languages/JavaLanguageService.kt2
-rw-r--r--src/Languages/LanguageService.kt12
2 files changed, 11 insertions, 3 deletions
diff --git a/src/Languages/JavaLanguageService.kt b/src/Languages/JavaLanguageService.kt
index bcd058b5..cf0f127b 100644
--- a/src/Languages/JavaLanguageService.kt
+++ b/src/Languages/JavaLanguageService.kt
@@ -34,6 +34,8 @@ public class JavaLanguageService : LanguageService {
}
}
+ override fun summarizeSignatures(nodes: List<DocumentationNode>): ContentNode? = null
+
private fun renderPackage(node: DocumentationNode): String {
return "package ${node.name}"
}
diff --git a/src/Languages/LanguageService.kt b/src/Languages/LanguageService.kt
index c587335a..b0f4bbc9 100644
--- a/src/Languages/LanguageService.kt
+++ b/src/Languages/LanguageService.kt
@@ -12,13 +12,19 @@ interface LanguageService {
}
/**
- * Renders a [node](DocumentationNode) as a class, function, property or other signature in a target language.
- * $node: A [DocumentationNode] to render
- * $returns: [ContentNode] which is a root for a rich content tree suitable for formatting with [FormatService]
+ * Renders a [node] as a class, function, property or other signature in a target language.
+ * @param node A [DocumentationNode] to render
+ * @return [ContentNode] which is a root for a rich content tree suitable for formatting with [FormatService]
*/
fun render(node: DocumentationNode, renderMode: RenderMode = RenderMode.FULL): ContentNode
/**
+ * Tries to summarize the signatures of the specified documentation nodes in a compact representation.
+ * Returns the representation if successful, or null if the signatures could not be summarized.
+ */
+ fun summarizeSignatures(nodes: List<DocumentationNode>): ContentNode?
+
+ /**
* Renders [node] as a named representation in the target language
*
* For example: