Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ebocher
ebocher committed Oct 28, 2024
1 parent 7623dc3 commit 704e8c2
Showing 1 changed file with 29 additions and 30 deletions.
59 changes: 29 additions & 30 deletions h2gis-functions/src/main/java/org/h2gis/functions/io/gpx/model/AbstractGpxParserDefault.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ public void clear() {
/**
* Gives copyright and license information governing use of the file.
*
* @return
* @return copyright value
*/
abstract String getCopyright();

Expand All @@ -136,8 +136,7 @@ public void clear() {
* @param tableName the table used to create all tables
* @param progress Progress visitor following the execution.
* @return a boolean value if the parser ends successfully or not
* @throws SQLException if the creation of the tables failed
* @throws java.io.FileNotFoundException
* @throws SQLException or FileNotFoundException if the creation of the tables failed
*/
public String[] read(String tableName, ProgressVisitor progress) throws SQLException, FileNotFoundException {
if (FileUtilities.isFileImportable(fileName, "gpx")) {
Expand Down Expand Up @@ -313,7 +312,7 @@ public void endElement(String uri, String localName, String qName) {
/**
* Gives the date when this file is created.
*
* @return
* @return time value
*/
public String getTime() {
return time;
Expand All @@ -322,7 +321,7 @@ public String getTime() {
/**
* Gives the version number of the GPX document.
*
* @return
* @return gpx version of the document
*/
public String getVersion() {
return version;
Expand All @@ -331,7 +330,7 @@ public String getVersion() {
/**
* Gives the name or URL of the software that created the GPX document.
*
* @return
* @return gpx creator
*/
public String getCreator() {
return creator;
Expand All @@ -340,7 +339,7 @@ public String getCreator() {
/**
* Gives the minimum longitude given by {@code <bounds>} element.
*
* @return
* @return the minimum longitude
*/
public double getMinLon() {
return minLon;
Expand All @@ -349,7 +348,7 @@ public double getMinLon() {
/**
* Gives the maximum longitude given by {@code <bounds>} element.
*
* @return
* @return the maximum longitude
*/
public double getMaxLon() {
return maxLon;
Expand All @@ -358,7 +357,7 @@ public double getMaxLon() {
/**
* Gives the minimum latitude given by {@code <bounds>} element.
*
* @return
* @return the minimum latitude
*/
public double getMinLat() {
return minLat;
Expand All @@ -367,7 +366,7 @@ public double getMinLat() {
/**
* Gives the maximum latitude given by {@code <bounds>} element.
*
* @return
* @return the maximum latitude
*/
public double getMaxLat() {
return maxLat;
Expand All @@ -376,7 +375,7 @@ public double getMaxLat() {
/**
* Gives a description of the contents of the GPX file.
*
* @return
* @return the description value
*/
public String getDesc() {
return desc;
Expand All @@ -386,7 +385,7 @@ public String getDesc() {
* Gives keywords associated with the file. Search engines or databases can
* use this information to classify the data.
*
* @return
* @return the keywords
*/
public String getKeywords() {
return keywords;
Expand All @@ -395,7 +394,7 @@ public String getKeywords() {
/**
* Gives URLs associated with the location described in the file.
*
* @return
* @return urls
*/
public String getFullLink() {
return "Link : " + link + "\nText of hyperlink : " + linkText;
Expand All @@ -406,16 +405,16 @@ public String getFullLink() {
* gives an email address if exist. Also gives a link to Web site or other
* external information about person if exist.
*
* @return
* @return author
*/
public String getFullAuthor() {
return "Author : " + authorName + "\nEmail : " + email + "\nLink : " + authorLink + "\nText : " + authorLinkText;
}

/**
* Set the link related to the author of the ducument.
* Set the link related to the author of the document.
*
* @param authorLink
* @param authorLink the link related to the author
*/
public void setAuthorLink(String authorLink) {
this.authorLink = authorLink;
Expand All @@ -424,7 +423,7 @@ public void setAuthorLink(String authorLink) {
/**
* Set the description of the link related to the author.
*
* @param authorLinkText
* @param authorLinkText the description of the link related to the author
*/
public void setAuthorLinkText(String authorLinkText) {
this.authorLinkText = authorLinkText;
Expand All @@ -433,7 +432,7 @@ public void setAuthorLinkText(String authorLinkText) {
/**
* Set the name of the author of the document.
*
* @param authorName
* @param authorName the name of the author
*/
public void setAuthorName(String authorName) {
this.authorName = authorName;
Expand All @@ -442,7 +441,7 @@ public void setAuthorName(String authorName) {
/**
* Set the email of the author of the document.
*
* @param email
* @param email the email of the author
*/
public void setEmail(String email) {
this.email = email;
Expand All @@ -451,16 +450,16 @@ public void setEmail(String email) {
/**
* Set the link related to the document.
*
* @param link
* @param link link related to the document
*/
public void setLink(String link) {
this.link = link;
}

/**
* Set the description of hte document link.
* Set the description of the document link.
*
* @param linkText
* @param linkText the description of the document link
*/
public void setLinkText(String linkText) {
this.linkText = linkText;
Expand All @@ -469,7 +468,7 @@ public void setLinkText(String linkText) {
/**
* Gives the name of the document.
*
* @return
* @return the name of the document
*/
public String getName() {
return name;
Expand All @@ -478,7 +477,7 @@ public String getName() {
/**
* Set the name of the document.
*
* @param name
* @param name the name of the document
*/
public void setName(String name) {
this.name = name;
Expand All @@ -487,7 +486,7 @@ public void setName(String name) {
/**
* Gives the parser used to parse waypoint.
*
* @return
* @return the wpt parse
*/
public AbstractGpxParserWpt getWptParser() {
return wptParser;
Expand All @@ -496,7 +495,7 @@ public AbstractGpxParserWpt getWptParser() {
/**
* Set the parser used to parse waypoint.
*
* @param wptParser
* @param wptParser set the wptParser
*/
public void setWptParser(AbstractGpxParserWpt wptParser) {
this.wptParser = wptParser;
Expand All @@ -505,7 +504,7 @@ public void setWptParser(AbstractGpxParserWpt wptParser) {
/**
* Set the parser used to parse routes.
*
* @param rteParser
* @param rteParser set the RTE parser
*/
public void setRteParser(AbstractGpxParserRte rteParser) {
this.rteParser = rteParser;
Expand All @@ -514,7 +513,7 @@ public void setRteParser(AbstractGpxParserRte rteParser) {
/**
* Gives the parser used to parse routes.
*
* @return
* @return the Rte parser
*/
public AbstractGpxParserRte getRteParser() {
return rteParser;
Expand All @@ -523,7 +522,7 @@ public AbstractGpxParserRte getRteParser() {
/**
* Set the parser used to parse the track
*
* @param trkParser
* @param trkParser set the trk parser
*/
public void setTrkParser(AbstractGpxParserTrk trkParser) {
this.trkParser = trkParser;
Expand All @@ -532,7 +531,7 @@ public void setTrkParser(AbstractGpxParserTrk trkParser) {
/**
* Givers the parser used to parse the track
*
* @return
* @return the Trk parser
*/
public AbstractGpxParserTrk getTrkParser() {
return trkParser;
Expand Down

0 comments on commit 704e8c2

Please sign in to comment.