1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugins.javadoc;
20
21 import javax.inject.Inject;
22
23 import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
24 import org.apache.maven.doxia.tools.SiteTool;
25 import org.apache.maven.plugins.annotations.Execute;
26 import org.apache.maven.plugins.annotations.LifecyclePhase;
27 import org.apache.maven.plugins.annotations.Mojo;
28 import org.apache.maven.plugins.annotations.ResolutionScope;
29 import org.apache.maven.plugins.javadoc.resolver.ResourceResolver;
30 import org.apache.maven.project.ProjectBuilder;
31 import org.apache.maven.toolchain.ToolchainManager;
32 import org.codehaus.plexus.archiver.manager.ArchiverManager;
33 import org.eclipse.aether.RepositorySystem;
34
35 /**
36 * Generates documentation for the <code>Java code</code> in a <b>NON aggregator</b> project using the standard
37 * <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>. Note that this
38 * goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}.
39 *
40 * @author <a href="mailto:mfriedenhagen@apache.org">Mirko Friedenhagen</a>
41 * @since 2.10
42 * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>
43 * @see <a href="http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#options">Javadoc Options</a>
44 */
45 @Mojo(name = "javadoc-no-fork", requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)
46 @Execute(phase = LifecyclePhase.NONE)
47 public class JavadocNoForkReport extends JavadocReport {
48
49 @Inject
50 public JavadocNoForkReport(
51 SiteTool siteTool,
52 ArchiverManager archiverManager,
53 ResourceResolver resourceResolver,
54 RepositorySystem repoSystem,
55 ArtifactHandlerManager artifactHandlerManager,
56 ProjectBuilder mavenProjectBuilder,
57 ToolchainManager toolchainManager) {
58 super(
59 siteTool,
60 archiverManager,
61 resourceResolver,
62 repoSystem,
63 artifactHandlerManager,
64 mavenProjectBuilder,
65 toolchainManager);
66 }
67 }