DocCommentable (Strange Eons API)

java.lang.Object
- ca.cgjennings.apps.arkham.plugins.typescript.DocCommentable

Direct Known Subclasses:

CompletionInfo.EntryDetails, Overview
```
public class DocCommentable
extends java.lang.Object
```
Extended by classes that can be annotated with doc comments. Not all comment parts may be present.

Field Summary

Fields
Modifier and Type	Field	Description
`java.lang.String`	`display`
`java.lang.String`	`documentation`
`java.lang.String`	`kind`
`java.lang.String`	`kindModifiers`
`java.lang.String`	`name`
`java.lang.String`	`source`
`java.util.List<DocTag>`	`tags`

Constructor Summary

Constructors
Constructor Description

DocCommentable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getSignature()`
`java.lang.String`	`toMarkup(MarkdownTransformer markdown, java.lang.String style)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kind
```
public java.lang.String kind
```

kindModifiers
```
public java.lang.String kindModifiers
```

name
```
public java.lang.String name
```

display
```
public java.lang.String display
```

documentation
```
public java.lang.String documentation
```

source
```
public java.lang.String source
```

tags
```
public java.util.List<DocTag> tags
```

Constructor Detail
- DocCommentable
```
public DocCommentable()
```

Method Detail

toMarkup

public java.lang.String toMarkup(MarkdownTransformer markdown,
                                 java.lang.String style)

getSignature

public java.lang.String getSignature()