aboutsummaryrefslogtreecommitdiff
path: root/src/Languages/LanguageService.kt
diff options
context:
space:
mode:
Diffstat (limited to 'src/Languages/LanguageService.kt')
-rw-r--r--src/Languages/LanguageService.kt8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/Languages/LanguageService.kt b/src/Languages/LanguageService.kt
index 191f12c4..97f8e621 100644
--- a/src/Languages/LanguageService.kt
+++ b/src/Languages/LanguageService.kt
@@ -14,9 +14,15 @@ trait LanguageService {
/**
* Renders [node] as a named representation in the target language
*
+ * For example:
+ * ${code org.jetbrains.dokka.example}
+ *
* $node: A [DocumentationNode] to render
* $returns: [String] which is a string representation of the node's name
*/
- fun renderName(node: DocumentationNode) : String
+ fun renderName(node: DocumentationNode): String
}
+fun example(service: LanguageService, node: DocumentationNode) {
+ println("Node name: ${service.renderName(node)}")
+} \ No newline at end of file