Skip to content
Merged

Typos #1237

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1023,10 +1023,10 @@ public AbstractJavadocMojo(
*
* <b>Notes</b>:
* <ol>
* <li>This option is ignored if the plugin is run in offline mode (using the {@code <offline>}
* setting or specifying {@code -o, --offline} or {@code -Dmaven.javadoc.offline=true} on the
* <li>This option is ignored if the plugin is run in offline mode using the {@code <offline>}
* setting or by specifying {@code -o, --offline} or {@code -Dmaven.javadoc.offline=true} on the
* command line.</li>
* <li>all given links should have a fetchable <code>/package-list</code> or <code>/element-list</code>
* <li>All given links should have a fetchable <code>/package-list</code> or <code>/element-list</code>
* (since Java 10). For instance:
* <pre>
* &lt;links&gt;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public class JavadocReport extends AbstractJavadocMojo implements MavenMultiPage

/**
* The name of the Javadoc report to be displayed in the Maven Generated Reports page
* (i.e. <code>project-reports.html</code>).
* (e.g. <code>project-reports.html</code>).
*
* @since 2.1
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public static Collection<Path> prunePaths(MavenProject project, Collection<Strin
*
* @param project the current Maven project not null
* @param dirs the collection of directories that will be validated
* @return a list of valid claspath elements as absolute paths
* @return a list of valid classpath elements as absolute paths
*/
public static Collection<Path> pruneDirs(MavenProject project, Collection<String> dirs) {
return prunePaths(project, dirs, false);
Expand Down
2 changes: 1 addition & 1 deletion src/site/apt/examples/aggregate-dependency-sources.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ org.test:project-distro:0.1
This is a pretty common direct dependency for projects that provide command-line execution options. But consider
what happens if commons-cli doesn't provide a <<<sources>>> jar: dependency-driven javadoc aggregation would fail
for any project that contained commons-cli as a direct dependency. To avoid this case, you have the option to fine-tune
which dependencies get included in the javadoc aggregation process. In your distribution project, add configuraiton
which dependencies get included in the javadoc aggregation process. In your distribution project, add configuration
for the <<<maven-javadoc-plugin>>> similar to the following:

+-----+
Expand Down
4 changes: 2 additions & 2 deletions src/site/apt/examples/aggregate-nofork.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@

Generate aggregate Javadoc without duplicate execution of phase compile.

* The standard goals <<<aggregate>>> and <<<test-aggregate>>> invoke separate lifecyles
* The standard goals <<<aggregate>>> and <<<test-aggregate>>> invoke separate lifecycles
<<<compile>>> and <<<test-compile>>>.

* In a CI environment you now might execute something like <<<mvn clean deploy site site-deploy>>>.

* During <<<site>>> build the standard reports will trigger <<<compile>>> or
<<<test-compile>>> again, depending on your build this may take some time, because
stuff like <<<enforcer>>> or generating stubs from a WDSL will be invoked again, which may lead
stuff like <<<enforcer>>> or generating stubs from a WSDL will be invoked again, which may lead
to longer build times.

* As of version 3.0.1 two new reports are defined, <<<aggregate-no-fork>>> and <<<test-aggregate-no-fork>>>
Expand Down
2 changes: 1 addition & 1 deletion src/site/apt/examples/alternate-doclet.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Using Alternate Doclet In Addition To The Javadoc Doclet

In this example, the doclet is Sun DocCheck ({{http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html/}}). The Sun Doc Check Doclet
is an extension to the Javadoc tool. It runs on source code and reviews documentation comments, generating an HTML
report that identifies empty comments and other ommissions and irregularities in the documentation comments.
report that identifies empty comments and other omissions and irregularities in the documentation comments.

+-----+
<project>
Expand Down
4 changes: 2 additions & 2 deletions src/site/apt/examples/alternate-javadoc-tool.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ Using Alternate Javadoc Tool
+-----+

<<IMPORTANT NOTE>>: by using {{{../javadoc-mojo.html#javadocExecutable}\<javadocExecutable/\>}} parameter, the build
will be plateform dependent! A good practice is to define an environnement variable (i.e. JAVA_1.6_HOME), so you
could specify it: (i.e. \<javadocExecutable\>\u0024\{env.JAVA_1.6_HOME\}/bin/javadoc\</javadocExecutable\>). An other
will be platform dependent! A good practice is to define an environment variable (e.g. JAVA_1.6_HOME), so you
could specify it: (e.g. \<javadocExecutable\>\u0024\{env.JAVA_1.6_HOME\}/bin/javadoc\</javadocExecutable\>). An other
ways is to define a POM property using \<project\>\<properties/\>\</project\>.

* Using Alternate Javadoc Version
Expand Down
4 changes: 2 additions & 2 deletions src/site/apt/examples/fix-javadocs.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ Fixing Javadoc Comments

* Features Summary

The user can skip the class/field/method Javadoc fixing using specific parameters, i.e.
The user can skip the class/field/method Javadoc fixing using specific parameters, e.g.
{{{../fix-mojo.html#fixClassComment}\<fixClassComment/\>}}.
Also, the user can specify a {{{../fix-mojo.html#level}\<level/\>}}, i.e. public, to fix only class/field/method with
Also, the user can specify a {{{../fix-mojo.html#level}\<level/\>}} such as public to fix only class/field/method with
the given level.

These goals can fix all Javadoc tags (by default, see {{{../fix-mojo.html#fixTags}\<fixTags/\>}}) or
Expand Down
6 changes: 3 additions & 3 deletions src/site/apt/examples/links-configuration.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ Configuring <<<links>>> Parameter
executable. To skip this link, you need to configure
{{{../javadoc-mojo.html#detectJavaApiLink}\<detectJavaApiLink/\>}} to <<<false>>>.

<<Note>>: if you are using an unsupported JDK like 7.0, you can add its Javadoc API url using the
{{{../javadoc-mojo.html#javaApiLinks}\<javaApiLinks/\>}} parameter, i.e.:
<<Note>>: if you are using an unsupported JDK like 7.0, you can add its Javadoc API URL using the
{{{../javadoc-mojo.html#javaApiLinks}\<javaApiLinks/\>}} parameter. For example:

+-----+
<configuration>
Expand All @@ -109,7 +109,7 @@ Configuring <<<links>>> Parameter
Configuring <<<offlineLinks>>> Parameter

If your project has modules, you can add cross reference links to your modules when your goals are not aggregator
goals. For instance, if your project has two modules i.e.:
goals. For instance, if your project has two modules, for example:

+-----+
<project>
Expand Down
4 changes: 2 additions & 2 deletions src/site/apt/examples/test-javadocs.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ yourproject

<<Notes>>:

[[1]] If you don't set \<testDoctitle/\> or \<testWindowtitle/\> parameters, the Test Javadoc report use the same
configuration (i.e. \<doctitle/\> or \<windowtitle/\> parameters) that Javadoc report (backward compatible reasons).
[[1]] If you don't set \<testDoctitle/\> or \<testWindowtitle/\> parameters, the Test Javadoc report uses the same
configuration (i.e. \<doctitle/\> or \<windowtitle/\> parameters) that Javadoc report uses (backward compatible reasons).

[[2]] To run the reports selectively, you need to include only the reports that you prefer.
Read the {{{./selective-javadocs-report.html}Selective Javadocs Reports}} part for more information.
Expand Down
2 changes: 1 addition & 1 deletion src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ javadoc.exe(or .sh) @options @packages | @argfile

* Examples

The following examples show how to use the Javadoc Plugin in more advanced usecases:
The following examples show how to use the Javadoc Plugin in more advanced use cases:

* {{{./examples/aggregate.html}Aggregating Javadocs for Multi-Projects}}

Expand Down
10 changes: 5 additions & 5 deletions src/site/fml/faq.fml
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,11 @@ javadoc.exe(or .sh) @options @packages | @argfile]]></source>
<answer>
<p>
You could need to add more J options (i.e. runtime system java options that runs Javadoc tool like -J-Xss)
to be process by the Javadoc Tool. For this, you should use the <i>&lt;additionalJOption/&gt;</i> parameter
to be processed by the Javadoc Tool. For this, you should use the <i>&lt;additionalJOption/&gt;</i> parameter
in your Javadoc Plugin configuration.
</p>
<p>
The Javadoc Plugin calls the Javadoc tool with J options, i.e.:
The Javadoc Plugin calls the Javadoc tool with J options, e.g.:
<source><![CDATA[
${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
-J-Xss128m \
Expand Down Expand Up @@ -176,7 +176,7 @@ ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
...
</settings>
]]></source>
With this, the Javadoc tool will be called with networking J options, i.e.:
With this, the Javadoc tool will be called with networking J options, e.g.:
<source><![CDATA[
${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
-J-Dhttp.proxySet=true \
Expand All @@ -192,7 +192,7 @@ ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
<b>Note</b>: If your proxy needs more JVM
<a href="https://docs.oracle.com/javase/7/docs/technotes/guides/net/properties.html">networking properties</a>
(like NTLM), you could always add JVM options using the <i>&lt;additionalJOption/&gt;</i> parameter
in your Javadoc Plugin configuration, i.e.:
in your Javadoc Plugin configuration, e.g.:
<source><![CDATA[
<configuration>
<additionalJOption>-J-Dhttp.auth.ntlm.domain=MYDOMAIN</additionalJOption>
Expand Down Expand Up @@ -284,7 +284,7 @@ mvn deploy:deploy-file \
<answer>
<p>
You need to configure the <i><a href="./javadoc-mojo.html#links">&lt;links/&gt;</a></i> parameter. Also, you
should correctly write references in your Javadoc, i.e.:
should correctly write references in your Javadoc. That is,
</p>
<ul>
<li><code>@see MyMojo</code> or <code>{@link MyMojo}</code> will <strong>NOT work</strong>.</li>
Expand Down
Loading