fix javadoc errors

maven-artifact/src/main/java/org/apache/maven/artifact/ArtifactUtils.java

@@ -173,7 +173,14 @@ public static Artifact copyArtifact( Artifact artifact )
         return clone;
     }
 
-    /** Returns <code>to</code> collection */
+    /**
+     * Copy artifact to a collection.
+     *
+     * @param <T> the target collection type
+     * @param from an artifact collection
+     * @param to the target artifact collection
+     * @return <code>to</code> collection
+     */
     public static <T extends Collection<Artifact>> T copyArtifacts( Collection<Artifact> from, T to )
     {
         for ( Artifact artifact : from )

maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java

@@ -73,10 +73,16 @@ public interface ArtifactRepository
     @Deprecated
     void setBlacklisted( boolean blackListed );
 
-    /** @since 3.8.1 **/
+    /**
+     * @return whether the repository is blocked
+     * @since 3.8.1
+     **/
     boolean isBlocked();
 
-    /** @since 3.8.1 **/
+    /**
+     * @param blocked block the repository?
+     * @since 3.8.1
+     **/
     void setBlocked( boolean blocked );
 
     //
@@ -84,7 +90,8 @@ public interface ArtifactRepository
     //
     /**
      *
-     * @param artifact
+     * @param artifact an artifact
+     * @return found artifact
      * @since 3.0-alpha-3
      */
     Artifact find( Artifact artifact );
@@ -108,20 +115,26 @@ public interface ArtifactRepository
     boolean isProjectAware();
 
     /**
+     * @param authentication authentication
      * @since 3.0-alpha-3
      */
     void setAuthentication( Authentication authentication );
+
     /**
+     * @return repository authentication
      * @since 3.0-alpha-3
      */
     Authentication getAuthentication();
 
     /**
+     * @param proxy proxy
      * @since 3.0-alpha-3
      */
     void setProxy( Proxy proxy );
+
     /**
      * @since 3.0-alpha-3
+     * @return repository proxy
      */
     Proxy getProxy();
 

maven-artifact/src/main/java/org/apache/maven/artifact/resolver/MultipleArtifactsNotFoundException.java

@@ -37,7 +37,12 @@ public class MultipleArtifactsNotFoundException
     private final List<Artifact> resolvedArtifacts;
     private final List<Artifact> missingArtifacts;
 
-    /** @deprecated use {@link #MultipleArtifactsNotFoundException(Artifact, List, List, List)} */
+    /**
+     * @param originatingArtifact the artifact that was being resolved
+     * @param missingArtifacts    artifacts that could not be resolved
+     * @param remoteRepositories  remote repositories where the missing artifacts were not found
+     * @deprecated use {@link #MultipleArtifactsNotFoundException(Artifact, List, List, List)}
+     */
     @Deprecated
     public MultipleArtifactsNotFoundException( Artifact originatingArtifact,
                                                List<Artifact> missingArtifacts,

maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java

@@ -101,8 +101,7 @@ public VersionRange cloneOf()
      *
      * @param spec string representation of a version or version range
      * @return a new {@link VersionRange} object that represents the spec
-     * @throws InvalidVersionSpecificationException
+     * @throws InvalidVersionSpecificationException if invalid version specification
-     *
      */
     public static VersionRange createFromVersionSpec( String spec )
         throws InvalidVersionSpecificationException

maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java

@@ -31,10 +31,18 @@
  */
 public interface ArtifactMetadata
 {
-    /** Whether this metadata should be stored alongside the artifact. */
+    /**
+     * Whether this metadata should be stored alongside the artifact.
+     *
+     * @return whether this metadata should be stored alongside the artifact
+     */
     boolean storedInArtifactVersionDirectory();
 
-    /** Whether this metadata should be stored alongside the group. */
+    /**
+     * Whether this metadata should be stored alongside the group.
+     *
+     * @return whether this metadata should be stored alongside the group
+     */
     boolean storedInGroupDirectory();
 
     String getGroupId();
@@ -73,6 +81,7 @@ public interface ArtifactMetadata
      *
      * @param localRepository  the local repository
      * @param remoteRepository the remote repository it came from
+     * @throws RepositoryMetadataStoreException in case of issue
      * TODO this should only be needed on the repository metadata
      */
     void storeInLocalRepository( ArtifactRepository localRepository,

maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollector.java

@@ -46,7 +46,7 @@ public interface ProblemCollector
      * The next messages will be bound to this source. When calling this method again, previous messages keep
      * their source, but the next messages will use the new source.
      *
-     * @param source
+     * @param source a source
      */
     void setSource( String source );
 

maven-builder-support/src/main/java/org/apache/maven/building/Source.java

@@ -34,6 +34,7 @@ public interface Source
      * Gets a byte stream to the source contents. Closing the returned stream is the responsibility of the caller.
      *
      * @return A byte stream to the source contents, never {@code null}.
+     * @throws IOException in case of IO issue
      */
     InputStream getInputStream()
         throws IOException;

maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java

@@ -49,6 +49,9 @@ int getId()
 
     /**
      * Helper method to simplify null processing
+     *
+     * @param scope a scope or {@code null}
+     * @return the provided scope or DEFAULT_SCOPE
      */
     public static ArtifactScopeEnum checkScope( ArtifactScopeEnum scope )
     {
@@ -99,7 +102,7 @@ else if ( id == 5 )
     /**
      * scope relationship function. Used by the graph conflict resolution policies
      *
-     * @param scope
+     * @param scope a scope
      * @return true is supplied scope is an inclusive sub-scope of current one.
      */
     public boolean encloses( ArtifactScopeEnum scope )

maven-compat/src/main/java/org/apache/maven/artifact/manager/WagonManager.java

@@ -40,6 +40,9 @@ public interface WagonManager
     /**
      * this method is only here for backward compat (project-info-reports:dependencies)
      * the default implementation will return an empty AuthenticationInfo
+     *
+     * @param id an id
+     * @return corresponding authentication info
      */
     AuthenticationInfo getAuthenticationInfo( String id );
 

maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java

@@ -311,7 +311,7 @@ private boolean loadMetadata( RepositoryMetadata repoMetadata, ArtifactRepositor
         return setRepository;
     }
 
-    /**
+    /*
      * TODO share with DefaultPluginMappingManager.
      */
     protected Metadata readMetadata( File mappingFile )

maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java

@@ -39,6 +39,9 @@ public abstract class AbstractMavenLifecycleParticipant
      *
      * This callback is intended to allow extensions to manipulate MavenProjects
      * before they are sorted and actual build execution starts.
+     *
+     * @param session the Maven session
+     * @throws MavenExecutionException in case of issue
      */
     public void afterProjectsRead( MavenSession session )
         throws MavenExecutionException
@@ -52,6 +55,9 @@ public void afterProjectsRead( MavenSession session )
      * This callback is intended to allow extensions to inject execution properties,
      * activate profiles and perform similar tasks that affect MavenProject
      * instance construction.
+     *
+     * @param session the Maven session
+     * @throws MavenExecutionException in case of issue
      */
     // TODO This is too early for build extensions, so maybe just remove it?
     public void afterSessionStart( MavenSession session )
@@ -67,6 +73,9 @@ public void afterSessionStart( MavenSession session )
      * allocated external resources after the build. It is invoked on best-effort
      * basis and may be missed due to an Error or RuntimeException in Maven core
      * code.
+     *
+     * @param session the Maven session
+     * @throws MavenExecutionException in case of issue
      * @since 3.2.1, MNG-5389
      */
     public void afterSessionEnd( MavenSession session )

maven-core/src/main/java/org/apache/maven/ArtifactFilterManager.java

@@ -31,6 +31,7 @@ public interface ArtifactFilterManager
     /**
      * Returns a filter for core + extension artifacts.
      *
+     * @return the artifact filter
      * @deprecated use {@code META-INF/maven/extension.xml} to define artifacts exported by Maven core and plugin
      *             extensions.
      */
@@ -38,12 +39,15 @@ public interface ArtifactFilterManager
 
     /**
      * Returns a filter for only the core artifacts.
+     *
+     * @return the artifact filter
      */
     ArtifactFilter getCoreArtifactFilter();
 
     /**
      * Exclude an extension artifact (doesn't affect getArtifactFilter's result, only getExtensionArtifactFilter).
      *
+     * @param artifactId an artifact id
      * @deprecated use {@code META-INF/maven/extension.xml} to define artifacts exported by Maven core and plugin
      *             extensions.
      */

maven-core/src/main/java/org/apache/maven/ProjectDependenciesResolver.java

@@ -45,6 +45,8 @@ public interface ProjectDependenciesResolver
      * @param scopesToResolve The dependency scopes that should be resolved, may be {@code null}.
      * @param session         The current build session, must not be {@code null}.
      * @return The transitive dependencies of the specified project that match the requested scopes, never {@code null}.
+     * @throws ArtifactResolutionException in case of resolution issue
+     * @throws ArtifactNotFoundException if an artifact is not found
      */
     Set<Artifact> resolve( MavenProject project, Collection<String> scopesToResolve, MavenSession session )
         throws ArtifactResolutionException, ArtifactNotFoundException;
@@ -57,6 +59,8 @@ Set<Artifact> resolve( MavenProject project, Collection<String> scopesToResolve,
      * @param scopesToResolve The dependency scopes that should be collected and also resolved, may be {@code null}.
      * @param session         The current build session, must not be {@code null}.
      * @return The transitive dependencies of the specified project that match the requested scopes, never {@code null}.
+     * @throws ArtifactResolutionException in case of resolution issue
+     * @throws ArtifactNotFoundException if an artifact is not found
      */
     Set<Artifact> resolve( MavenProject project, Collection<String> scopesToCollect,
                            Collection<String> scopesToResolve, MavenSession session )
@@ -71,6 +75,8 @@ Set<Artifact> resolve( MavenProject project, Collection<String> scopesToCollect,
      * @param session             The current build session, must not be {@code null}.
      * @param ignoreableArtifacts Artifacts that need not be resolved
      * @return The transitive dependencies of the specified project that match the requested scopes, never {@code null}.
+     * @throws ArtifactResolutionException in case of resolution issue
+     * @throws ArtifactNotFoundException if an artifact is not found
      */
     Set<Artifact> resolve( MavenProject project, Collection<String> scopesToCollect,
                            Collection<String> scopesToResolve, MavenSession session, Set<Artifact> ignoreableArtifacts )
@@ -87,6 +93,8 @@ Set<Artifact> resolve( MavenProject project, Collection<String> scopesToCollect,
      * @param session  The current build session, must not be {@code null}.
      * @return The transitive dependencies of the specified projects that match the requested scopes, never
      *         {@code null}.
+     * @throws ArtifactResolutionException in case of resolution issue
+     * @throws ArtifactNotFoundException if an artifact is not found
      */
     Set<Artifact> resolve( Collection<? extends MavenProject> projects, Collection<String> scopes,
                            MavenSession session )

maven-core/src/main/java/org/apache/maven/artifact/metadata/ArtifactMetadataRetrievalException.java

@@ -29,21 +29,31 @@ public class ArtifactMetadataRetrievalException
     extends org.apache.maven.repository.legacy.metadata.ArtifactMetadataRetrievalException
 {
 
-    /** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
+    /**
+     * @param message a message
+     * @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
+     */
     @Deprecated
     public ArtifactMetadataRetrievalException( String message )
     {
         super( message, null, null );
     }
 
-    /** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
+    /**
+     * @param cause a cause
+     * @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
+     */
     @Deprecated
     public ArtifactMetadataRetrievalException( Throwable cause )
     {
         super( null, cause, null );
     }
 
-    /** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
+    /**
+     * @param message a message
+     * @param cause a cause
+     * @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
+     */
     @Deprecated
     public ArtifactMetadataRetrievalException( String message,
                                                Throwable cause )

maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadataManager.java

@@ -48,6 +48,7 @@ void resolveAlways( RepositoryMetadata metadata, ArtifactRepository localReposit
      * @param metadata             the metadata to deploy
      * @param localRepository      the local repository to install to first
      * @param deploymentRepository the remote repository to deploy to
+     * @throws RepositoryMetadataDeploymentException in case of metadata deployment issue
      */
     void deploy( ArtifactMetadata metadata, ArtifactRepository localRepository,
                  ArtifactRepository deploymentRepository )
@@ -58,6 +59,7 @@ void deploy( ArtifactMetadata metadata, ArtifactRepository localRepository,
      *
      * @param metadata        the metadata
      * @param localRepository the local repository
+     * @throws RepositoryMetadataInstallationException in case of metadata installation issue
      */
     void install( ArtifactMetadata metadata, ArtifactRepository localRepository )
         throws RepositoryMetadataInstallationException;

maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java

@@ -189,6 +189,9 @@ public boolean hasVersionRangeViolations()
      * TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
      *       {@link #getVersionRangeViolation(int)} but it's not used like that in
      *       DefaultLegacyArtifactCollector
+     *
+     * @param e an exception
+     * @return {@code this}
      */
     public ArtifactResolutionResult addVersionRangeViolation( Exception e )
     {

maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java

@@ -113,7 +113,7 @@ public void addDependencies( Set<Artifact> artifacts, List<ArtifactRepository> r
 
     /**
      * @return {@link List} &lt; {@link String} &gt; with artifact ids
-     * @throws OverConstrainedVersionException
+     * @throws OverConstrainedVersionException if version specification is over constrained
      */
     public List<String> getDependencyTrail()
         throws OverConstrainedVersionException
@@ -172,6 +172,8 @@ public boolean isResolved()
 
     /**
      * Test whether the node is direct or transitive dependency.
+     *
+     * @return whether the node is direct or transitive dependency
      */
     public boolean isChildOfRootNode()
     {

maven-core/src/main/java/org/apache/maven/bridge/MavenRepositorySystem.java

@@ -614,8 +614,8 @@ public Set<String> getRepoIds( List<ArtifactRepository> repositories )
     /**
      * Source from org.apache.maven.repository.legacy.LegacyRepositorySystem#getEffectiveRepositories
      *
-     * @param repositories
+     * @param repositories a list of repositories
-     * @return
+     * @return corresponding effective repositories
      * @since 3.6.1
      */
     public List<ArtifactRepository> getEffectiveRepositories( List<ArtifactRepository> repositories )

maven-core/src/main/java/org/apache/maven/classrealm/ClassRealmRequest.java

@@ -72,6 +72,7 @@ enum RealmType
 
     /**
      * @deprecated Use {@link #getParentImports()} instead.
+     * @return imports
      */
     @Deprecated
     List<String> getImports();

maven-core/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadataRetrievalException.java

@@ -31,21 +31,31 @@ public class ArtifactMetadataRetrievalException
 {
     private Artifact artifact;
 
-    /** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
+    /**
+     * @param message a message
+     * @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
+     */
     @Deprecated
     public ArtifactMetadataRetrievalException( String message )
     {
         this( message, null, null );
     }
 
-    /** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
+    /**
+     * @param cause a cause
+     * @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
+     */
     @Deprecated
     public ArtifactMetadataRetrievalException( Throwable cause )
     {
         this( null, cause, null );
     }
 
-    /** @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)} */
+    /**
+     * @param message a message
+     * @param cause a cause
+     * @deprecated use {@link #ArtifactMetadataRetrievalException(String, Throwable, Artifact)}
+     */
     @Deprecated
     public ArtifactMetadataRetrievalException( String message,
                                                Throwable cause )

maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java

@@ -217,6 +217,12 @@ public static int doMain( String[] args, ClassWorld classWorld )
      * This supports painless invocation by the Verifier during embedded execution of the core ITs.
      * See <a href="http://maven.apache.org/shared/maven-verifier/xref/org/apache/maven/it/Embedded3xLauncher.html">
      * <code>Embedded3xLauncher</code> in <code>maven-verifier</code></a>
+     *
+     * @param args CLI args
+     * @param workingDirectory working directory
+     * @param stdout stdout
+     * @param stderr stderr
+     * @return return code
      */
     public int doMain( String[] args, String workingDirectory, PrintStream stdout, PrintStream stderr )
     {

maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java

@@ -167,7 +167,7 @@ public DefaultModelBuilder(
 
     /**
      * @deprecated since Maven 4
-     * @see DefaultModelBuilderFactory#set
+     * @see DefaultModelBuilderFactory#setModelProcessor(ModelProcessor) 
      */
     @Deprecated
     public DefaultModelBuilder setModelProcessor( ModelProcessor modelProcessor )
@@ -223,7 +223,7 @@ public DefaultModelBuilder setModelInterpolator( ModelInterpolator modelInterpol
 
     /**
      * @deprecated since Maven 4
-     * @see DefaultModelBuilderFactory#set
+     * @see DefaultModelBuilderFactory#setModelPathTranslator(ModelPathTranslator)
      */
     @Deprecated
     public DefaultModelBuilder setModelPathTranslator( ModelPathTranslator modelPathTranslator )
@@ -279,7 +279,7 @@ public DefaultModelBuilder setInheritanceAssembler( InheritanceAssembler inherit
 
     /**
      * @deprecated since Maven 4
-     * @see DefaultModelBuilderFactory#set
+     * @see DefaultModelBuilderFactory#setProfileSelector(ProfileSelector)
      */
     @Deprecated
     public DefaultModelBuilder setProfileSelector( ProfileSelector profileSelector )

maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java

@@ -39,7 +39,7 @@
  * Could encode these variants as subclasses, but kept in one for now
  *
  * @author bbusjaeger
- * @param <T>
+ * @param <T> the model type
  */
 public class Result<T>
 {

maven-model/src/main/java/org/apache/maven/model/merge/ModelMerger.java

@@ -2640,7 +2640,7 @@ protected KeyComputer<Exclusion> getExclusionKey()
 
     /**
      * Use to compute keys for data structures
-     * @param <T>
+     * @param <T> the data structure type
      */
     @FunctionalInterface
     public interface KeyComputer<T> extends Function<T, Object>