Improve Javadoc.

jenetics · Nov 9, 2023 · 204c335 · 204c335
1 parent 1dc1e39
commit 204c335
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 12 deletions.
diff --git a/jpx/src/main/java/io/jenetics/jpx/GPX.java b/jpx/src/main/java/io/jenetics/jpx/GPX.java
@@ -2076,7 +2076,7 @@ public static void write(final GPX gpx, final Path path) throws IOException {
 	}
 
 	/**
-	 * Read an GPX object from the given {@code input} stream.
+	 * Read a GPX object from the given {@code input} stream.
 	 * This method is a shortcut for
 	 * {@snippet lang="java":
 	 * GPX.Reader.DEFAULT.read(path);

diff --git a/jpx/src/main/java/io/jenetics/jpx/Person.java b/jpx/src/main/java/io/jenetics/jpx/Person.java
@@ -52,7 +52,7 @@ public final class Person implements Serializable {
 	 *
 	 * @param name name of person or organization
 	 * @param email the person's email address
-	 * @param link link to Web site or other external information about person
+	 * @param link link to website or other external information about person
 	 */
 	private Person(final String name, final Email email, final Link link) {
 		_name = name;
@@ -79,9 +79,9 @@ public Optional<Email> getEmail() {
 	}
 
 	/**
-	 * Return the link to Web site or other external information about person.
+	 * Return the link to website or other external information about person.
 	 *
-	 * @return the link to Web site or other external information about person
+	 * @return the link to website or other external information about person
 	 */
 	public Optional<Link> getLink() {
 		return Optional.ofNullable(_link);
@@ -137,7 +137,7 @@ public String toString() {
 	 *
 	 * @param name name of person or organization
 	 * @param email the person's email address
-	 * @param link link to Web site or other external information about person
+	 * @param link link to website or other external information about person
 	 * @return a new {@code Person} object with the given parameters
 	 */
 	public static Person of(final String name, final Email email, final Link link) {

diff --git a/jpx/src/main/java/io/jenetics/jpx/format/LatitudeMinute.java b/jpx/src/main/java/io/jenetics/jpx/format/LatitudeMinute.java
@@ -21,7 +21,7 @@
 import io.jenetics.jpx.Latitude;
 
 /**
- * This field allows to access the absolute value of the minute part of the
+ * This field allows accessing the absolute value of the minute part of the
  * latitude of a given location.
  *
  * @version 2.2

diff --git a/jpx/src/main/java/io/jenetics/jpx/format/LatitudeSecond.java b/jpx/src/main/java/io/jenetics/jpx/format/LatitudeSecond.java
@@ -21,7 +21,7 @@
 import io.jenetics.jpx.Latitude;
 
 /**
- * This field allows to access the absolute value of the second part of the
+ * This field allows accessing the absolute value of the second part of the
  * latitude of a given location.
  *
  * @version 2.2

diff --git a/jpx/src/main/java/io/jenetics/jpx/format/Location.java b/jpx/src/main/java/io/jenetics/jpx/format/Location.java
@@ -128,7 +128,7 @@ public String toString() {
 	 * Create a new location form the given GPS point.
 	 *
 	 * @param point the GPS point
-	 * @return a new location form the given GPS point
+	 * @return a new location from the given GPS point
 	 * @throws NullPointerException if the given {@code point} is {@code null}
 	 */
 	public static Location of(final Point point) {

diff --git a/jpx/src/main/java/io/jenetics/jpx/format/LongitudeMinute.java b/jpx/src/main/java/io/jenetics/jpx/format/LongitudeMinute.java
@@ -21,7 +21,7 @@
 import io.jenetics.jpx.Longitude;
 
 /**
- * This field allows to access the absolute value of the minute part of the
+ * This field allows accessing the absolute value of the minute part of the
  * longitude of a given location.
  *
  * @version 2.2

diff --git a/jpx/src/main/java/io/jenetics/jpx/format/LongitudeSecond.java b/jpx/src/main/java/io/jenetics/jpx/format/LongitudeSecond.java
@@ -21,7 +21,7 @@
 import io.jenetics.jpx.Longitude;
 
 /**
- * This field allows to access the absolute value of the second part of the
+ * This field allows accessing the absolute value of the second part of the
  * longitude of a given location.
  *
  * @version 2.2

diff --git a/jpx/src/main/java/io/jenetics/jpx/package-info.java b/jpx/src/main/java/io/jenetics/jpx/package-info.java
@@ -21,7 +21,7 @@
 /**
  * This is the base package of the <a href="https://github.com/jenetics/jpx">
  * JPX</a> library. It contains the <em>domain</em> objects which are needed
- * for fully modelling of the <a href="https://www.topografix.com/GPX/1/1/">
+ * for full modeling of the <a href="https://www.topografix.com/GPX/1/1/">
  * GPX standard 1.1</a> and <a href="http://www.topografix.com/gpx_manual.as">
  * 1.0</a>.
  *

diff --git a/jpx/src/main/java/module-info.java b/jpx/src/main/java/module-info.java
@@ -21,7 +21,7 @@
  * format. It is a <em>full</em> implementation of version
  * <a href="http://www.topografix.com/GPX/1/1/">1.1</a> and version
  * <a href="http://www.topografix.com/gpx_manual.as">1.0</a> of the GPX format.
- * The data classes are completely immutable and allows a functional programming
+ * The data classes are completely immutable and allow a functional programming
  * style. It is also possible to convert the location information into strings
  * which are compatible to the <a href="http://en.wikipedia.org/wiki/ISO_6709">
  * ISO 6709</a> standard.