improved javadoc Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/eddfef33 Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/eddfef33 Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/eddfef33
Branch: refs/heads/master Commit: eddfef33942d483136d547452c63a2d98665d718 Parents: b8d220c Author: Hervé Boutemy <hbout...@apache.org> Authored: Wed Nov 5 01:24:32 2014 +0100 Committer: Hervé Boutemy <hbout...@apache.org> Committed: Wed Nov 5 01:24:32 2014 +0100 ---------------------------------------------------------------------- .../java/org/apache/maven/toolchain/DefaultToolchain.java | 1 + .../src/main/java/org/apache/maven/toolchain/Toolchain.java | 7 +++++++ .../java/org/apache/maven/toolchain/ToolchainFactory.java | 5 +++-- .../java/org/apache/maven/toolchain/ToolchainManager.java | 3 ++- .../org/apache/maven/toolchain/java/DefaultJavaToolchain.java | 2 ++ .../java/org/apache/maven/toolchain/java/JavaToolchain.java | 2 ++ 6 files changed, 17 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/eddfef33/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java b/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java index 8196246..65d947c 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java @@ -27,6 +27,7 @@ import org.apache.maven.toolchain.model.ToolchainModel; import org.codehaus.plexus.logging.Logger; /** + * Default toolchain implementation. * * @author mkleint * @since 2.0.9 http://git-wip-us.apache.org/repos/asf/maven/blob/eddfef33/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java b/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java index 5e99b0a..c6c6ebf 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java @@ -20,6 +20,8 @@ package org.apache.maven.toolchain; */ /** + * Toolchain interface. + * * @author Milos Kleint * @author Jason van Zyl * @since 2.0.9 @@ -27,6 +29,11 @@ package org.apache.maven.toolchain; public interface Toolchain { + /** + * get the type of toolchain. + * + * @return the toolchain type + */ String getType(); /** http://git-wip-us.apache.org/repos/asf/maven/blob/eddfef33/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java index a187f96..c1c2aa9 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java @@ -22,7 +22,8 @@ package org.apache.maven.toolchain; import org.apache.maven.toolchain.model.ToolchainModel; /** - * + * Internal toolchain factory, to prepare toolchains instances. + * * @author mkleint * @since 2.0.9 */ @@ -35,7 +36,7 @@ public interface ToolchainFactory throws MisconfiguredToolchainException; /** - * Returns the default instance of the particular type of toolchain, can return null + * Returns the default instance of the particular type of toolchain, can return <code>null</code> * if not applicable. * TODO keep around?? **/ http://git-wip-us.apache.org/repos/asf/maven/blob/eddfef33/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java index 6b8acf5..ee49b07 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java @@ -23,7 +23,8 @@ import org.apache.maven.execution.MavenSession; /** - * + * Public API for a plugin to get a toolchain instance. + * * @author mkleint * @since 2.0.9 */ http://git-wip-us.apache.org/repos/asf/maven/blob/eddfef33/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchain.java b/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchain.java index 5364d67..ee82013 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchain.java @@ -28,6 +28,8 @@ import org.codehaus.plexus.util.FileUtils; import org.codehaus.plexus.util.Os; /** + * JDK toolchain implementation. + * * @author Milos Kleint * @since 2.0.9 */ http://git-wip-us.apache.org/repos/asf/maven/blob/eddfef33/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolchain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolchain.java b/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolchain.java index 20b3624..8cfc8f8 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolchain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolchain.java @@ -22,6 +22,8 @@ package org.apache.maven.toolchain.java; import org.apache.maven.toolchain.Toolchain; /** + * JDK toolchain interface. + * * @author Jason van Zyl * @author Milos Kleint * @since 2.0.9
