From 204c33577b9ab2ecd2324295925c5ac10641af84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20Wilhelmst=C3=B6tter?= Date: Wed, 8 Nov 2023 22:39:23 +0100 Subject: [PATCH] Improve Javadoc. --- jpx/src/main/java/io/jenetics/jpx/GPX.java | 2 +- jpx/src/main/java/io/jenetics/jpx/Person.java | 8 ++++---- .../main/java/io/jenetics/jpx/format/LatitudeMinute.java | 2 +- .../main/java/io/jenetics/jpx/format/LatitudeSecond.java | 2 +- jpx/src/main/java/io/jenetics/jpx/format/Location.java | 2 +- .../main/java/io/jenetics/jpx/format/LongitudeMinute.java | 2 +- .../main/java/io/jenetics/jpx/format/LongitudeSecond.java | 2 +- jpx/src/main/java/io/jenetics/jpx/package-info.java | 2 +- jpx/src/main/java/module-info.java | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/jpx/src/main/java/io/jenetics/jpx/GPX.java b/jpx/src/main/java/io/jenetics/jpx/GPX.java index 080d9373..7cc63e8a 100644 --- 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 index 7e88aa21..257739f0 100644 --- 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 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 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 index 7195c702..9684fb67 100644 --- 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 index 82d999f2..f331fc93 100644 --- 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 index 1397a747..e7a179b2 100644 --- 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 index cec7a6e2..d92c4a24 100644 --- 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 index c78354c8..e372b930 100644 --- 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 index fd1fb681..fb2888dc 100644 --- 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 * JPX library. It contains the domain objects which are needed - * for fully modelling of the + * for full modeling of the * GPX standard 1.1 and * 1.0. * diff --git a/jpx/src/main/java/module-info.java b/jpx/src/main/java/module-info.java index 4f7a2372..3a92d48a 100644 --- a/jpx/src/main/java/module-info.java +++ b/jpx/src/main/java/module-info.java @@ -21,7 +21,7 @@ * format. It is a full implementation of version * 1.1 and version * 1.0 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 * ISO 6709 standard.