Skip to content

Commit 77a3bed

Browse files
authored
Typos (#1237)
* typos
1 parent 90cd443 commit 77a3bed

File tree

12 files changed

+24
-24
lines changed

12 files changed

+24
-24
lines changed

src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,10 +1023,10 @@ public AbstractJavadocMojo(
10231023
*
10241024
* <b>Notes</b>:
10251025
* <ol>
1026-
* <li>This option is ignored if the plugin is run in offline mode (using the {@code <offline>}
1027-
* setting or specifying {@code -o, --offline} or {@code -Dmaven.javadoc.offline=true} on the
1026+
* <li>This option is ignored if the plugin is run in offline mode using the {@code <offline>}
1027+
* setting or by specifying {@code -o, --offline} or {@code -Dmaven.javadoc.offline=true} on the
10281028
* command line.</li>
1029-
* <li>all given links should have a fetchable <code>/package-list</code> or <code>/element-list</code>
1029+
* <li>All given links should have a fetchable <code>/package-list</code> or <code>/element-list</code>
10301030
* (since Java 10). For instance:
10311031
* <pre>
10321032
* &lt;links&gt;

src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public class JavadocReport extends AbstractJavadocMojo implements MavenMultiPage
7070

7171
/**
7272
* The name of the Javadoc report to be displayed in the Maven Generated Reports page
73-
* (i.e. <code>project-reports.html</code>).
73+
* (e.g. <code>project-reports.html</code>).
7474
*
7575
* @since 2.1
7676
*/

src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ public static Collection<Path> prunePaths(MavenProject project, Collection<Strin
152152
*
153153
* @param project the current Maven project not null
154154
* @param dirs the collection of directories that will be validated
155-
* @return a list of valid claspath elements as absolute paths
155+
* @return a list of valid classpath elements as absolute paths
156156
*/
157157
public static Collection<Path> pruneDirs(MavenProject project, Collection<String> dirs) {
158158
return prunePaths(project, dirs, false);

src/site/apt/examples/aggregate-dependency-sources.apt.vm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ org.test:project-distro:0.1
136136
This is a pretty common direct dependency for projects that provide command-line execution options. But consider
137137
what happens if commons-cli doesn't provide a <<<sources>>> jar: dependency-driven javadoc aggregation would fail
138138
for any project that contained commons-cli as a direct dependency. To avoid this case, you have the option to fine-tune
139-
which dependencies get included in the javadoc aggregation process. In your distribution project, add configuraiton
139+
which dependencies get included in the javadoc aggregation process. In your distribution project, add configuration
140140
for the <<<maven-javadoc-plugin>>> similar to the following:
141141

142142
+-----+

src/site/apt/examples/aggregate-nofork.apt.vm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@
2424

2525
Generate aggregate Javadoc without duplicate execution of phase compile.
2626

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

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

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

3737
* As of version 3.0.1 two new reports are defined, <<<aggregate-no-fork>>> and <<<test-aggregate-no-fork>>>

src/site/apt/examples/alternate-doclet.apt.vm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Using Alternate Doclet In Addition To The Javadoc Doclet
6363

6464
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
6565
is an extension to the Javadoc tool. It runs on source code and reviews documentation comments, generating an HTML
66-
report that identifies empty comments and other ommissions and irregularities in the documentation comments.
66+
report that identifies empty comments and other omissions and irregularities in the documentation comments.
6767

6868
+-----+
6969
<project>

src/site/apt/examples/alternate-javadoc-tool.apt.vm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ Using Alternate Javadoc Tool
5858
+-----+
5959

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

6565
* Using Alternate Javadoc Version

src/site/apt/examples/fix-javadocs.apt.vm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Fixing Javadoc Comments
4040

4141
* Features Summary
4242

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

4848
These goals can fix all Javadoc tags (by default, see {{{../fix-mojo.html#fixTags}\<fixTags/\>}}) or

src/site/apt/examples/links-configuration.apt.vm

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ Configuring <<<links>>> Parameter
8888
executable. To skip this link, you need to configure
8989
{{{../javadoc-mojo.html#detectJavaApiLink}\<detectJavaApiLink/\>}} to <<<false>>>.
9090

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

9494
+-----+
9595
<configuration>
@@ -109,7 +109,7 @@ Configuring <<<links>>> Parameter
109109
Configuring <<<offlineLinks>>> Parameter
110110

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

114114
+-----+
115115
<project>

src/site/apt/examples/test-javadocs.apt.vm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ yourproject
9898

9999
<<Notes>>:
100100

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

104104
[[2]] To run the reports selectively, you need to include only the reports that you prefer.
105105
Read the {{{./selective-javadocs-report.html}Selective Javadocs Reports}} part for more information.

0 commit comments

Comments
 (0)