diff options
Diffstat (limited to 'src/Languages/LanguageService.kt')
| -rw-r--r-- | src/Languages/LanguageService.kt | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/Languages/LanguageService.kt b/src/Languages/LanguageService.kt index 97f8e621..3508b48d 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 |