[MNG-5713] improved Toolchains API description

maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java

@@ -28,6 +28,7 @@ import org.codehaus.plexus.logging.Logger;
 /**
  *
  * @author mkleint
+ * @since 2.0.9
  */
 public abstract class DefaultToolchain
     implements Toolchain, ToolchainPrivate

maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java

@@ -22,6 +22,7 @@ package org.apache.maven.toolchain;
 /**
  * @author Milos Kleint
  * @author Jason van Zyl
+ * @since 2.0.9
  */
 public interface Toolchain
 {

maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java

@@ -24,6 +24,7 @@ import org.apache.maven.toolchain.model.ToolchainModel;
 /**
  *
  * @author mkleint
+ * @since 2.0.9
  */
 public interface ToolchainFactory
 {

maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java

@@ -25,6 +25,7 @@ import org.apache.maven.execution.MavenSession;
 /**
  *
  * @author mkleint
+ * @since 2.0.9
  */
 public interface ToolchainManager
 {

maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java

@@ -23,20 +23,26 @@ import org.apache.maven.execution.MavenSession;
 
 
 /**
- * Component for use by the maven-toolchains-plugin only.
+ * Component for use by the <code>maven-toolchains-plugin</code> only.
+ * 
  * @author mkleint
+ * @since 2.0.9
  */
 public interface ToolchainManagerPrivate
 {
 
     /**
      * Retrieves the toolchains of given type from the user settings.
+     * 
+     * @since 3.0 (addition of the <code>MavenSession</code> parameter)
      */
     ToolchainPrivate[] getToolchainsForType( String type, MavenSession context )
         throws MisconfiguredToolchainException;
 
     /**
      * Stores the toolchain into build context.
+     * 
+     * @since 2.0.9
      */
     void storeToolchainToBuildContext( ToolchainPrivate toolchain, MavenSession context );
 

maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolChain.java

@@ -30,6 +30,7 @@ import org.codehaus.plexus.util.Os;
 
 /**
  * @author Milos Kleint
+ * @since 2.0.9
  */
 @Component( role = JavaToolChain.class )
 public class DefaultJavaToolChain

maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchainFactory.java

@@ -35,6 +35,7 @@ import org.codehaus.plexus.util.xml.Xpp3Dom;
 /**
  *
  * @author mkleint
+ * @since 2.0.9
  */
 @Component( role = ToolchainFactory.class, hint = "jdk" )
 public class DefaultJavaToolchainFactory

maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolChain.java

@@ -24,6 +24,7 @@ import org.apache.maven.toolchain.Toolchain;
 /**
  * @author Jason van Zyl
  * @author Milos Kleint
+ * @since 2.0.9
  */
 public interface JavaToolChain
     extends Toolchain

maven-core/src/site/apt/index.apt

@@ -33,8 +33,6 @@ Maven Core
 
  * {{{./artifact-handlers.html}default artifact handlers}},
 
- * {{{./toolchains.html}Toolchains descriptor reference}},
-
  * <<<Maven>>> component ({{{./apidocs/org/apache/maven/Maven.html}javadoc}}),
  with its <<<DefaultMaven>>> implementation ({{{./xref/org/apache/maven/DefaultMaven.html}source}}),
 
@@ -59,3 +57,18 @@ Maven Core
  with its <<<DefaultExceptionHandler>>> implementation
  ({{{./xref/org/apache/maven/exception/DefaultExceptionHandler.html}source}}), use to transform exception into useful end-user messages.
 
+* Toolchains
+
+ * {{{./toolchains.html}Toolchains descriptor reference}},
+
+ * <<<ToolchainManager>>> component ({{{./apidocs/org/apache/maven/toolchain/ToolchainManager.html}javadoc}}))
+ with its <<<DefaultToolchainManager>>> implementation ({{{./xref/org/apache/maven/toolchain/DefaultToolchainManager.html}source}}),
+ to get selected <<<Toolchain>>> ({{{./apidocs/org/apache/maven/toolchain/Toolchain.html}javadoc}}) instance,
+
+ * internal <<<ToolchainManagerPrivate>>> component ({{{./apidocs/org/apache/maven/toolchain/ToolchainManagerPrivate.html}javadoc}}))
+ with its <<<DefaultToolchainManagerPrivate>>> implementation ({{{./xref/org/apache/maven/toolchain/DefaultToolchainManagerPrivate.html}source}}),
+ to manage toolchain selection,
+
+ * <<<JavaToolchain>>> component ({{{./apidocs/org/apache/maven/toolchain/java/JavaToolchain.html}javadoc}}),
+ with its <<<DefaultJavaToolchain>>> implementation
+ ({{{./xref/org/apache/maven/toolchain/java/DefaultJavaToolchain.html}source}}).