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
|
package org.jetbrains.dokka.maven
import org.apache.maven.archiver.MavenArchiveConfiguration
import org.apache.maven.archiver.MavenArchiver
import org.apache.maven.execution.MavenSession
import org.apache.maven.plugin.AbstractMojo
import org.apache.maven.plugins.annotations.*
import org.apache.maven.project.MavenProject
import org.apache.maven.project.MavenProjectHelper
import org.codehaus.plexus.archiver.Archiver
import org.codehaus.plexus.archiver.jar.JarArchiver
import org.jetbrains.dokka.DocumentationOptions
import org.jetbrains.dokka.DokkaGenerator
import org.jetbrains.dokka.SourceLinkDefinitionImpl
import org.jetbrains.dokka.SourceRootImpl
import java.io.File
class SourceLinkMapItem {
@Parameter(name = "dir", required = true)
var dir: String = ""
@Parameter(name = "url", required = true)
var url: String = ""
@Parameter(name = "urlSuffix")
var urlSuffix: String? = null
}
abstract class AbstractDokkaMojo : AbstractMojo() {
@Parameter(required = true, defaultValue = "\${project.compileSourceRoots}")
var sourceDirectories: List<String> = emptyList()
@Parameter
var samplesDirs: List<String> = emptyList()
@Parameter
@Deprecated("Use <includes> instead")
var includeDirs: List<String> = emptyList()
@Parameter
var includes: List<String> = emptyList()
@Parameter(required = true, defaultValue = "\${project.compileClasspathElements}")
var classpath: List<String> = emptyList()
@Parameter
var sourceLinks: Array<SourceLinkMapItem> = emptyArray()
@Parameter(required = true, defaultValue = "\${project.artifactId}")
var moduleName: String = ""
@Parameter(required = false, defaultValue = "false")
var skip: Boolean = false
@Parameter(required = false, defaultValue = "6")
var jdkVersion: Int = 6
protected abstract fun getOutDir(): String
protected abstract fun getOutFormat(): String
override fun execute() {
if (skip) {
log.info("Dokka skip parameter is true so no dokka output will be produced")
return
}
val gen = DokkaGenerator(
MavenDokkaLogger(log),
classpath,
sourceDirectories.map { SourceRootImpl(it) },
samplesDirs,
includeDirs + includes,
moduleName,
DocumentationOptions(getOutDir(), getOutFormat(),
sourceLinks = sourceLinks.map { SourceLinkDefinitionImpl(it.dir, it.url, it.urlSuffix) },
jdkVersion = jdkVersion
)
)
gen.generate()
}
}
@Mojo(name = "dokka", defaultPhase = LifecyclePhase.PRE_SITE, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)
class DokkaMojo : AbstractDokkaMojo() {
@Parameter(required = true, defaultValue = "html")
var outputFormat: String = "html"
@Parameter(required = true, defaultValue = "\${project.basedir}/target/dokka")
var outputDir: String = ""
override fun getOutFormat() = outputFormat
override fun getOutDir() = outputDir
}
@Mojo(name = "javadoc", defaultPhase = LifecyclePhase.PRE_SITE, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)
class DokkaJavadocMojo : AbstractDokkaMojo() {
@Parameter(required = true, defaultValue = "\${project.basedir}/target/dokkaJavadoc")
var outputDir: String = ""
override fun getOutFormat() = "javadoc"
override fun getOutDir() = outputDir
}
@Mojo(name = "javadocJar", defaultPhase = LifecyclePhase.PRE_SITE, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)
class DokkaJavadocJarMojo : AbstractDokkaMojo() {
@Parameter(required = true, defaultValue = "\${project.basedir}/target/dokkaJavadocJar")
var outputDir: String = ""
/**
* Specifies the directory where the generated jar file will be put.
*/
@Parameter(property = "project.build.directory")
private var jarOutputDirectory: String? = null
/**
* Specifies the filename that will be used for the generated jar file. Please note that `-javadoc`
* or `-test-javadoc` will be appended to the file name.
*/
@Parameter(property = "project.build.finalName")
private var finalName: String? = null
/**
* Specifies whether to attach the generated artifact to the project helper.
*/
@Parameter(property = "attach", defaultValue = "true")
private val attach: Boolean = false
/**
* The archive configuration to use.
* See [Maven Archiver Reference](http://maven.apache.org/shared/maven-archiver/index.html)
*/
@Parameter
private val archive = MavenArchiveConfiguration()
@Parameter(property = "maven.javadoc.classifier", defaultValue = "javadoc", required = true)
private var classifier: String? = null
@Parameter(defaultValue = "\${session}", readonly = true, required = true)
protected var session: MavenSession? = null
@Parameter(defaultValue = "\${project}", readonly = true, required = true)
protected var project: MavenProject? = null
@Component
private var projectHelper: MavenProjectHelper? = null
@Component(role = Archiver::class, hint = "jar")
private var jarArchiver: JarArchiver? = null
override fun getOutFormat() = "javadoc"
override fun getOutDir() = outputDir
override fun execute() {
super.execute()
if(!File(outputDir).exists()) {
log.warn("No javadoc generated so no javadoc jar will be generated")
return
}
val outputFile = generateArchive("$finalName-$classifier.jar")
if (attach) {
projectHelper?.attachArtifact(project, "javadoc", classifier, outputFile)
}
}
private fun generateArchive(jarFileName: String): File {
val javadocJar = File(jarOutputDirectory, jarFileName)
val archiver = MavenArchiver()
archiver.setArchiver(jarArchiver)
archiver.setOutputFile(javadocJar)
archiver.archiver.addDirectory(File(outputDir), arrayOf("**/**"), arrayOf())
archive.setAddMavenDescriptor(false)
archiver.createArchive(session, project, archive)
return javadocJar
}
}
|
