azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

delete KDoc Maven plugin

Browse Source
This commit is contained in:
Dmitry Jemerov
2015-07-20 17:52:03 +02:00
parent b791ea03a9
commit b3a2ee2148
6 changed files with 0 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/docs/jsdoc/pom.xml
-78
View File
@@ -1,78 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-project</artifactId>
<version>1.0-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<artifactId>jsdoc</artifactId>
<properties>
<js.lib.dir>${basedir}/../../../js/js.libraries</js.lib.dir>
</properties>
<dependencies>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit-version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kdoc-maven-plugin</artifactId>
<version>${project.version}</version>
<configuration>
<sources>
<source>${js.lib.dir}/src/core</source>
<source>${js.lib.dir}/src/html5</source>
<source>${js.lib.dir}/src/jquery</source>
<source>${js.lib.dir}/src/raphael</source>
</sources>
<title>Kotlin JavaScript API (${project.version})</title>
<ignorePackages>
<ignorePackage>com</ignorePackage>
<ignorePackage>sun</ignorePackage>
<ignorePackage>java</ignorePackage>
<ignorePackage>junit</ignorePackage>
<ignorePackage>org</ignorePackage>
</ignorePackages>
</configuration>
<executions>
<execution>
<id>apidoc</id>
<phase>install</phase>
<goals>
<goal>apidoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
libraries/pom.xml
-1
View File
@@ -95,7 +95,6 @@
<module>tools/kotlin-js-tests</module>
<module>tools/kotlin-js-tests-junit</module>
<module>tools/kdoc</module>
<module>tools/kdoc-maven-plugin</module>
<module>kunit</module>
<module>kotlin-jdbc</module>
libraries/tools/kdoc-maven-plugin/ReadMe.md
-8
View File
@@ -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)
libraries/tools/kdoc-maven-plugin/pom.xml
-57
View File
@@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<properties>
<maven-plugin-anno.version>1.4.1</maven-plugin-anno.version>
<maven.version>3.0.4</maven.version>
</properties>
<parent>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-project</artifactId>
<version>0.1-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<artifactId>kdoc-maven-plugin</artifactId>
<packaging>maven-plugin</packaging>
<dependencies>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kdoc</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.pegdown</groupId>
<artifactId>pegdown</artifactId>
<version>${pegdown.version}</version>
</dependency>
</dependencies>
<build>
<sourceDirectory>src/main/java</sourceDirectory>
<testSourceDirectory>src/test/java</testSourceDirectory>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<version>2.9</version>
</plugin>
</plugins>
</build>
</project>
libraries/tools/kdoc-maven-plugin/src/main/java/org/jetbrains/kotlin/maven/doc/KDocMojo.java
-218
View File
@@ -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<String> 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<String> 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<String,String> 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<String,String> 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<String, String> packageSummaryText;
@Override
public List<String> getSources() {
return sources;
}
@Override
protected K2JVMCompiler createCompiler() {
return new KDocCompiler();
}
@Override
protected K2JVMCompilerArguments createCompilerArguments() {
return new KDocArguments();
}
@Override
@NotNull
protected ExitCode executeCompiler(
@NotNull CLICompiler<K2JVMCompilerArguments> 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!");
}
}
}
libraries/tools/kdoc-maven-plugin/src/test/java/org/jetbrains/kotlin/maven/MojoTest.java
-26
View File
@@ -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() {
}
}