aboutsummaryrefslogtreecommitdiff
path: root/src/Languages/LanguageService.kt
diff options
context:
space:
mode:
authorDmitry Jemerov <yole@jetbrains.com>2015-01-12 17:23:07 +0100
committerDmitry Jemerov <yole@jetbrains.com>2015-01-12 17:23:07 +0100
commit0c584d0e12f07946fdfc8cc0e9f132558ff794fc (patch)
treee91219e900010aae0cfc0a95499ddd5650f201e7 /src/Languages/LanguageService.kt
parentc4f40a03404641a9a42e6518cb066f2e0ae609e0 (diff)
downloaddokka-0c584d0e12f07946fdfc8cc0e9f132558ff794fc.tar.gz
dokka-0c584d0e12f07946fdfc8cc0e9f132558ff794fc.tar.bz2
dokka-0c584d0e12f07946fdfc8cc0e9f132558ff794fc.zip
enum values continued
Diffstat (limited to 'src/Languages/LanguageService.kt')
-rw-r--r--src/Languages/LanguageService.kt9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/Languages/LanguageService.kt b/src/Languages/LanguageService.kt
index 191f12c4..35fea501 100644
--- a/src/Languages/LanguageService.kt
+++ b/src/Languages/LanguageService.kt
@@ -4,12 +4,19 @@ package org.jetbrains.dokka
* Provides facility for rendering [DocumentationNode] as a language-dependent declaration
*/
trait LanguageService {
+ enum class RenderMode {
+ /** Brief signature (used in a list of all members of the class). */
+ SUMMARY
+ /** Full signature (used in the page describing the member itself */
+ FULL
+ }
+
/**
* 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]
*/
- fun render(node: DocumentationNode): ContentNode
+ fun render(node: DocumentationNode, renderMode: RenderMode = RenderMode.FULL): ContentNode
/**
* Renders [node] as a named representation in the target language