aboutsummaryrefslogtreecommitdiff
path: root/test/src/format/MarkdownFormatTest.kt
blob: 9dc10393bde81ade61f04045b9d892b7364b92b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
package org.jetbrains.dokka.tests

import org.jetbrains.dokka.KotlinLanguageService
import org.jetbrains.dokka.MarkdownFormatService
import org.junit.Test

public class MarkdownFormatTest {
    private val markdownService = MarkdownFormatService(InMemoryLocationService, KotlinLanguageService())

    @Test fun emptyDescription() {
        verifyOutput("test/data/format/emptyDescription.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun classWithCompanionObject() {
        verifyOutput("test/data/format/classWithCompanionObject.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun annotations() {
        verifyOutput("test/data/format/annotations.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun annotationClass() {
        verifyOutput("test/data/format/annotationClass.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun annotationParams() {
        verifyOutput("test/data/format/annotationParams.kt", ".md", withKotlinRuntime = true) { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun extensions() {
        verifyOutput("test/data/format/extensions.kt", ".package.md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members)
        }
        verifyOutput("test/data/format/extensions.kt", ".class.md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun enumClass() {
        verifyOutput("test/data/format/enumClass.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
        verifyOutput("test/data/format/enumClass.kt", ".value.md") { model, output ->
            val enumClassNode = model.members.single().members[0]
            markdownService.appendNodes(tempLocation, output,
                    enumClassNode.members.filter { it.name == "LOCAL_CONTINUE_AND_BREAK" })
        }
    }

    @Test fun varargsFunction() {
        verifyOutput("test/data/format/varargsFunction.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun overridingFunction() {
        verifyOutput("test/data/format/overridingFunction.kt", ".md") { model, output ->
            val classMembers = model.members.single().members.first { it.name == "D" }.members
            markdownService.appendNodes(tempLocation, output, classMembers.filter { it.name == "f" })
        }

    }

    @Test fun propertyVar() {
        verifyOutput("test/data/format/propertyVar.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun functionWithDefaultParameter() {
        verifyOutput("test/data/format/functionWithDefaultParameter.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun accessor() {
        verifyOutput("test/data/format/accessor.kt", ".md") { model, output ->
            val propertyNode = model.members.single().members.first { it.name == "C" }.members.filter { it.name == "x" }
            markdownService.appendNodes(tempLocation, output, propertyNode)
        }
    }

    @Test fun paramTag() {
        verifyOutput("test/data/format/paramTag.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun throwsTag() {
        verifyOutput("test/data/format/throwsTag.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun typeParameterBounds() {
        verifyOutput("test/data/format/typeParameterBounds.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun typeParameterVariance() {
        verifyOutput("test/data/format/typeParameterVariance.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun typeProjectionVariance() {
        verifyOutput("test/data/format/typeProjectionVariance.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun javadocHtml() {
        verifyOutput("test/data/format/javadocHtml.java", ".md", withJdk = true) { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun javaCodeLiteralTags() {
        verifyOutput("test/data/format/javaCodeLiteralTags.java", ".md", withJdk = true) { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun javaCodeInParam() {
        verifyOutput("test/data/format/javaCodeInParam.java", ".md", withJdk = true) { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun javaSpaceInAuthor() {
        verifyOutput("test/data/format/javaSpaceInAuthor.java", ".md", withJdk = true) { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun nullability() {
        verifyOutput("test/data/format/nullability.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun operatorOverloading() {
        verifyOutput("test/data/format/operatorOverloading.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members.single { it.name == "C" }.members.filter { it.name == "plus" })
        }
    }

    @Test fun javadocOrderedList() {
        verifyOutput("test/data/format/javadocOrderedList.java", ".md", withJdk = true) { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members.filter { it.name == "Bar" })
        }
    }

    @Test fun companionObjectExtension() {
        verifyOutput("test/data/format/companionObjectExtension.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members.filter { it.name == "Foo" })
        }
    }

    @Test fun starProjection() {
        verifyOutput("test/data/format/starProjection.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun extensionFunctionParameter() {
        verifyOutput("test/data/format/extensionFunctionParameter.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }

    @Test fun summarizeSignatures() {
        verifyOutput("test/data/format/summarizeSignatures.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members)
        }
    }

    @Test fun summarizeSignaturesProperty() {
        verifyOutput("test/data/format/summarizeSignaturesProperty.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members)
        }
    }

    @Test fun reifiedTypeParameter() {
        verifyOutput("test/data/format/reifiedTypeParameter.kt", ".md") { model, output ->
            markdownService.appendNodes(tempLocation, output, model.members.single().members)
        }
    }
}