diff --git a/libraries/docs/jsdoc/pom.xml b/libraries/docs/jsdoc/pom.xml deleted file mode 100644 index 2a9b8116145..00000000000 --- a/libraries/docs/jsdoc/pom.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - 4.0.0 - - - org.jetbrains.kotlin - kotlin-project - 1.0-SNAPSHOT - ../../pom.xml - - - jsdoc - - - ${basedir}/../../../js/js.libraries - - - - - org.jetbrains.kotlin - kotlin-stdlib - ${project.version} - - - junit - junit - ${junit-version} - - - - - - - org.apache.maven.plugins - maven-deploy-plugin - - true - - - - - org.jetbrains.kotlin - kdoc-maven-plugin - ${project.version} - - - ${js.lib.dir}/src/core - ${js.lib.dir}/src/html5 - ${js.lib.dir}/src/jquery - ${js.lib.dir}/src/raphael - - Kotlin JavaScript API (${project.version}) - - com - sun - java - junit - org - - - - - - - apidoc - install - - apidoc - - - - - - - diff --git a/libraries/pom.xml b/libraries/pom.xml index 263bbfdbab4..120305026d5 100644 --- a/libraries/pom.xml +++ b/libraries/pom.xml @@ -95,7 +95,6 @@ tools/kotlin-js-tests tools/kotlin-js-tests-junit tools/kdoc - tools/kdoc-maven-plugin kunit kotlin-jdbc diff --git a/libraries/tools/kdoc-maven-plugin/ReadMe.md b/libraries/tools/kdoc-maven-plugin/ReadMe.md deleted file mode 100644 index 12d243d5035..00000000000 --- a/libraries/tools/kdoc-maven-plugin/ReadMe.md +++ /dev/null @@ -1,8 +0,0 @@ -## KDoc Maven Plugin - -This Maven plugin allows you to create API Documentation for your Kotlin code (rather like javadoc but more kool :) -as it allows embedded [markdown](http://daringfireball.net/projects/markdown/syntax#block) wiki markup. - -For examples check out the [Kotlin API docs](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/index.html). - -For more details see [how to write code with comments](http://confluence.jetbrains.net/display/Kotlin/Coding+Conventions) \ No newline at end of file diff --git a/libraries/tools/kdoc-maven-plugin/pom.xml b/libraries/tools/kdoc-maven-plugin/pom.xml deleted file mode 100644 index 14b98fd1d00..00000000000 --- a/libraries/tools/kdoc-maven-plugin/pom.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - 4.0.0 - - 1.4.1 - 3.0.4 - - - - org.jetbrains.kotlin - kotlin-project - 0.1-SNAPSHOT - ../../pom.xml - - - kdoc-maven-plugin - maven-plugin - - - - org.jetbrains.kotlin - kdoc - ${project.version} - - - org.jetbrains.kotlin - kotlin-maven-plugin - ${project.version} - - - org.pegdown - pegdown - ${pegdown.version} - - - - - src/main/java - src/test/java - - - - org.apache.maven.plugins - maven-compiler-plugin - - - - org.apache.maven.plugins - maven-plugin-plugin - 2.9 - - - - diff --git a/libraries/tools/kdoc-maven-plugin/src/main/java/org/jetbrains/kotlin/maven/doc/KDocMojo.java b/libraries/tools/kdoc-maven-plugin/src/main/java/org/jetbrains/kotlin/maven/doc/KDocMojo.java deleted file mode 100644 index de40054fbb8..00000000000 --- a/libraries/tools/kdoc-maven-plugin/src/main/java/org/jetbrains/kotlin/maven/doc/KDocMojo.java +++ /dev/null @@ -1,218 +0,0 @@ -/* - * Copyright 2010-2013 JetBrains s.r.o. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.jetbrains.kotlin.maven.doc; - -import org.apache.maven.plugin.MojoExecutionException; -import org.jetbrains.annotations.NotNull; -import org.jetbrains.kotlin.cli.common.CLICompiler; -import org.jetbrains.kotlin.cli.common.ExitCode; -import org.jetbrains.kotlin.cli.common.arguments.K2JVMCompilerArguments; -import org.jetbrains.kotlin.cli.common.messages.MessageCollector; -import org.jetbrains.kotlin.cli.jvm.K2JVMCompiler; -import org.jetbrains.kotlin.doc.KDocArguments; -import org.jetbrains.kotlin.doc.KDocCompiler; -import org.jetbrains.kotlin.doc.KDocConfig; -import org.jetbrains.kotlin.maven.K2JVMCompileMojo; - -import java.util.List; -import java.util.Map; - -/** - * Generates API docs documentation for kotlin sources - * - * @goal apidoc - * @phase site - * @requiresDependencyResolution test - * @noinspection UnusedDeclaration - */ -public class KDocMojo extends K2JVMCompileMojo { - // TODO not sure why default is stopping us passing this value in via a config - // default-value="${project.compileSourceRoots}" - - /** - * The sources used to compile - * - * @parameter expression="${sources}" - * @required - */ - private List sources; - - /** - * The directory for the generated KDocs - * - * @parameter expression="${docOutputDir}" default-value="${basedir}/target/site/apidocs" - * @required - */ - private String docOutputDir; - - /** - * The module to use for documentation - * - * @parameter expression="${docModule}" - */ - private String docModule; - - /** - * Package prefixes which are excluded from the kdoc - * - * @parameter expression="${ignorePackages}" - */ - protected List ignorePackages; - - /** - * Whether protected classes, functions and properties should be included - * - * @parameter expression="${includeProtected}" default-value="true" - */ - private boolean includeProtected; - - /** - * The title of the documentation - * - * @parameter expression="${title}" default-value="KDoc for ${project.artifactId}" - */ - private String title; - - /** - * The version of the documentation - * - * @parameter expression="${version}" default-value="KDoc for ${project.version" - */ - private String version; - - /** - * The HTTP link to source code - * - * @parameter expression="${sourceRootHref}" - */ - private String sourceRootHref; - - /** - * The root project directory used to deduce relative file names when linking to source code - * - * @parameter expression="${projectRootDir}" default-value="${project.basedir}" - */ - private String projectRootDir; - - /** - * Whether warnings should be generated if no comments could be found for classes, functions and properties being documented - * - * @parameter expression="${warnNoComments}" default-value="true" - */ - private boolean warnNoComments; - - /** - * A Map of package name to file names for the description of packages. - * This allows you to refer to ReadMe.md files in your project root directory which will then be included in the API Doc. - * For packages which are not configured, KDoc will look for ReadMe.html or ReadMe.md files in the package source directory - * - * @parameter expression="${packageDescriptionFiles}" - */ - private Map packageDescriptionFiles; - - /** - * A Map of package name prefixes to HTTP URLs so we can link the API docs to external packages - * - * @parameter expression="${packagePrefixToUrls}" - */ - private Map packagePrefixToUrls; - - /** - * A Map of package name to summary text used in the package overview tables to give a brief summary for each package - * - * @parameter expression="${packagePrefixToUrls}" - */ - private Map packageSummaryText; - - @Override - public List getSources() { - return sources; - } - - @Override - protected K2JVMCompiler createCompiler() { - return new KDocCompiler(); - } - - @Override - protected K2JVMCompilerArguments createCompilerArguments() { - return new KDocArguments(); - } - - @Override - @NotNull - protected ExitCode executeCompiler( - @NotNull CLICompiler compiler, - @NotNull K2JVMCompilerArguments arguments, - @NotNull MessageCollector messageCollector - ) { - ExitCode exitCode = super.executeCompiler(compiler, arguments, messageCollector); - if (exitCode == ExitCode.COMPILATION_ERROR) { - // KDoc should ignore compilation errors, since it's not supposed to compile code. - // KDoc is supposed to generate documentation by the code that may be correct or not - return ExitCode.OK; - } - return exitCode; - } - - @Override - protected void configureSpecificCompilerArguments(K2JVMCompilerArguments arguments) throws MojoExecutionException { - if (arguments instanceof KDocArguments) { - KDocArguments kdoc = (KDocArguments) arguments; - KDocConfig docConfig = kdoc.getDocConfig(); - docConfig.setDocOutputDir(docOutputDir); - - kdoc.noJdkAnnotations = true; - kdoc.annotations = getFullAnnotationsPath(getLog(), annotationPaths); - - if (ignorePackages != null) { - docConfig.getIgnorePackages().addAll(ignorePackages); - } - if (packageDescriptionFiles != null) { - docConfig.getPackageDescriptionFiles().putAll(packageDescriptionFiles); - } - if (packagePrefixToUrls != null) { - docConfig.getPackagePrefixToUrls().putAll(packagePrefixToUrls); - } - if (packageSummaryText != null) { - docConfig.getPackageSummaryText().putAll(packageSummaryText); - } - docConfig.setIncludeProtected(includeProtected); - docConfig.setTitle(title); - docConfig.setVersion(version); - docConfig.setWarnNoComments(warnNoComments); - docConfig.setSourceRootHref(sourceRootHref); - docConfig.setProjectRootDir(projectRootDir); - - LOG.info("API docs output to: " + docConfig.getDocOutputDir()); - LOG.info("classpath: " + classpath); - LOG.info("title: " + title); - LOG.info("sources: " + sources); - LOG.info("sourceRootHref: " + sourceRootHref); - LOG.info("projectRootDir: " + projectRootDir); - LOG.info("kotlin annotations: " + kdoc.annotations); - LOG.info("packageDescriptionFiles: " + packageDescriptionFiles); - LOG.info("packagePrefixToUrls: " + packagePrefixToUrls); - LOG.info("API docs ignore packages: " + ignorePackages); - } - else { - LOG.warn("No KDocArguments available!"); - } - - } -} - diff --git a/libraries/tools/kdoc-maven-plugin/src/test/java/org/jetbrains/kotlin/maven/MojoTest.java b/libraries/tools/kdoc-maven-plugin/src/test/java/org/jetbrains/kotlin/maven/MojoTest.java deleted file mode 100644 index be60712a176..00000000000 --- a/libraries/tools/kdoc-maven-plugin/src/test/java/org/jetbrains/kotlin/maven/MojoTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright 2010-2013 JetBrains s.r.o. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.jetbrains.kotlin.maven; - -import org.junit.Test; - -public class MojoTest { - @Test - public void dummy() { - - } -}