improved javadoc

This commit is contained in:
Hervé Boutemy 2014-11-05 01:24:32 +01:00
parent b8d220c686
commit eddfef3394
6 changed files with 17 additions and 3 deletions

View File

@ -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

View File

@ -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();
/**

View File

@ -22,6 +22,7 @@ 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??
**/

View File

@ -23,6 +23,7 @@ import org.apache.maven.execution.MavenSession;
/**
* Public API for a plugin to get a toolchain instance.
*
* @author mkleint
* @since 2.0.9

View File

@ -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
*/

View File

@ -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