Ignore:
Timestamp:
2018-04-08T15:24:48+02:00 (7 years ago)
Author:
donvip
Message:

fix javadoc warnings

Location:
applications/editors/josm/plugins/opendata
Files:
14 edited

Legend:

Unmodified
Added
Removed

  • applications/editors/josm/plugins/opendata/.settings/org.eclipse.jdt.core.prefs

    r34152 r34153  
    5656org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
    5757org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
    58 org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
     58org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
    5959org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
    6060org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled

  • applications/editors/josm/plugins/opendata/includes/org/jopendocument/model/table/TableTable.java

    r30568 r34153  
    11/*
    22 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    3  * 
     3 *
    44 * Copyright 2008 jOpenDocument, by ILM Informatique. All rights reserved.
    5  * 
     5 *
    66 * The contents of this file are subject to the terms of the GNU
    7  * General Public License Version 3 only ("GPL"). 
    8  * You may not use this file except in compliance with the License. 
     7 * General Public License Version 3 only ("GPL").
     8 * You may not use this file except in compliance with the License.
    99 * You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
    1010 * See the License for the specific language governing permissions and limitations under the License.
    11  * 
     11 *
    1212 * When distributing the software, include this License Header Notice in each file.
    13  * 
     13 *
    1414 */
    1515
    … …  
    2020
    2121/**
    22  * 
     22 *
    2323 */
    2424public class TableTable {
    … …  
    7171    /**
    7272     * Return all the rows (duplicated if repeated)
     73     * @return all the rows (duplicated if repeated)
    7374     */
    7475    public List<TableTableRow> getRows() {
    … …  
    7879    /**
    7980     * Sets the value of the tablePrintRanges property.
    80      * 
     81     *
    8182     * @param value allowed object is {@link String }
    82      * 
     83     *
    8384     */
    8485    public void setTablePrintRanges(final String value) {

  • applications/editors/josm/plugins/opendata/includes/org/jopendocument/model/table/TableTableCell.java

    r29298 r34153  
    11/*
    22 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    3  * 
     3 *
    44 * Copyright 2008 jOpenDocument, by ILM Informatique. All rights reserved.
    5  * 
     5 *
    66 * The contents of this file are subject to the terms of the GNU
    7  * General Public License Version 3 only ("GPL"). 
    8  * You may not use this file except in compliance with the License. 
     7 * General Public License Version 3 only ("GPL").
     8 * You may not use this file except in compliance with the License.
    99 * You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
    1010 * See the License for the specific language governing permissions and limitations under the License.
    11  * 
     11 *
    1212 * When distributing the software, include this License Header Notice in each file.
    13  * 
     13 *
    1414 */
    1515
    … …  
    2323
    2424    protected int tableNumberColumnsRepeated = 1;
    25    
     25
    2626    protected String tableStyleName;
    2727
    … …  
    5151    /**
    5252     * Gets the value of the tableStyleName property.
    53      * 
     53     *
    5454     * @return possible object is {@link String }
    55      * 
     55     *
    5656     */
    5757    public String getStyleName() {
    … …  
    6161    /**
    6262     * Gets the value of the tableNumberColumnsRepeated property.
    63      *
     63     * @return the value of the tableNumberColumnsRepeated property.
    6464     */
    6565    public int getTableNumberColumnsRepeated() {
    6666        return this.tableNumberColumnsRepeated;
    6767    }
    68    
     68
    6969    public TextP getTextP() {
    7070        return this.textP;
    … …  
    7373    /**
    7474     * Sets the value of the tableNumberColumnsRepeated property.
    75      * 
     75     *
    7676     * @param value allowed object is {@link String }
    77      * 
     77     *
    7878     */
    7979    public void setTableNumberColumnsRepeated(final String value) {
    … …  
    8585    /**
    8686     * Sets the value of the tableStyleName property.
    87      * 
     87     *
    8888     * @param value allowed object is {@link String }
    89      * 
     89     *
    9090     */
    9191    public void setTableStyleName(final String value) {

  • applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/io/geographic/MifReader.java

    r33518 r34153  
    619619    }
    620620
    621     /** Compare two doubles within a default epsilon */
     621    /**
     622     * Compare two doubles within a default epsilon
     623     * @param a first double
     624     * @param b second double
     625     * @return {@code true} if {@code a} and {@code b} are equals
     626     */
    622627    public static boolean equals(Double a, Double b) {
    623628        if (a == b) return true;

  • applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ModuleHandler.java

    r34151 r34153  
    187187     * depends on should be missing.
    188188     *
     189     * @param parent parent component
    189190     * @param modules the collection of all loaded modules
    190191     * @param module the module for which preconditions are checked
    … …  
    198199     * Creates a class loader for loading module code.
    199200     *
    200      * @param modules the collection of modules which are going to be loaded with this
    201      * class loader
     201     * @param modules the collection of modules which are going to be loaded with this class loader
    202202     * @return the class loader
    203203     */
    … …  
    225225     * the class loader <code>moduleClassLoader</code>.
    226226     *
     227     * @param parent parent component
    227228     * @param module the module
    228229     * @param moduleClassLoader the module class loader
    … …  
    262263
    263264    /**
    264      * Loads the module in <code>modules</code> from locally available jar files into
    265      * memory.
    266      *
     265     * Loads the module in <code>modules</code> from locally available jar files into memory.
     266     *
     267     * @param parent parent component
    267268     * @param modules the list of modules
    268269     * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
    … …  
    356357    /**
    357358     * Builds the set of modules to load. Deprecated and unmaintained modules are filtered
    358      * out. This involves user interaction. This method displays alert and confirmation
    359      * messages.
    360      *
     359     * out. This involves user interaction. This method displays alert and confirmation messages.
     360     *
     361     * @param parent parent component
    361362     * @return the set of modules to load (as set of module names)
    362363     */
    … …  
    417418     * @param modules the collection of modules to update. Must not be null.
    418419     * @param monitor the progress monitor. Defaults to {@link NullProgressMonitor#INSTANCE} if null.
     420     * @return list of modules
    419421     * @throws IllegalArgumentException thrown if modules is null
    420422     */
    … …  
    499501     * Ask the user for confirmation that a module shall be disabled.
    500502     *
     503     * @param parent parent component
    501504     * @param reason the reason for disabling the module
    502505     * @param name the module name

  • applications/editors/josm/plugins/opendata/src/org/openstreetmap/josm/plugins/opendata/core/modules/ModuleInformation.java

    r34151 r34153  
    223223     * @param klass the module class
    224224     * @return the instantiated and initialized module
     225     * @throws ModuleException if the module cannot be loaded or initialized
    225226     */
    226227    public Module load(Class<? extends Module> klass) throws ModuleException {
    … …  
    237238     * @param classLoader the class loader to use
    238239     * @return the loaded class
     240     * @throws ModuleException if the class cannot be found
    239241     */
    240242    @SuppressWarnings("unchecked")
    … …  
    326328    /**
    327329     * Replies the name of the module
     330     * @return the name of the module
    328331     */
    329332    public String getName() {

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/NonRegFunctionalTests.java

    r33156 r34153  
    2323import org.openstreetmap.josm.tools.CheckParameterUtil;
    2424
     25/**
     26 * Superclass of non-reg functional tests.
     27 */
    2528public abstract class NonRegFunctionalTests {
    2629
    2730    /**
    2831     * Non-regression generic test.
     32     * @param context context
     33     * @param ds data set
    2934     */
    3035    public static void testGeneric(String context, DataSet ds) {
    … …  
    5257    /**
    5358     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/10214">#10214</a>
     59     * @param ds data set
    5460     */
    5561    public static void testTicket10214(DataSet ds) {
    … …  
    7076     * Lists all datasets files matching given extension.
    7177     * @param ext file extension to search for
     78     * @return all datasets files matching given extension
    7279     * @returns List of all datasets files matching given extension
    7380     * @throws IOException in case of I/O error

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/geographic/GmlReaderTest.java

    r33156 r34153  
    77import java.io.File;
    88import java.io.FileInputStream;
    9 import java.io.IOException;
    109import java.io.InputStream;
    11 
    12 import javax.xml.stream.FactoryConfigurationError;
    13 import javax.xml.stream.XMLStreamException;
    1410
    1511import org.junit.Rule;
    … …  
    3228    /**
    3329     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/11624">#11624</a>
    34      * @throws IOException if an error occurs during reading
     30     * @throws Exception if an error occurs during reading
    3531     */
    3632    @Test
    37     public void testTicket11624() throws IOException, XMLStreamException, FactoryConfigurationError {
     33    public void testTicket11624() throws Exception {
    3834        File file = new File(TestUtils.getRegressionDataFile(11624, "temp3.gml"));
    3935        try (InputStream is = new FileInputStream(file)) {

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/geographic/KmlReaderTest.java

    r33156 r34153  
    55import static org.junit.Assert.assertTrue;
    66
    7 import java.io.IOException;
    87import java.io.InputStream;
    9 
    10 import javax.xml.stream.FactoryConfigurationError;
    11 import javax.xml.stream.XMLStreamException;
    128
    139import org.junit.Rule;
    … …  
    4642    /**
    4743     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/12694">#12694</a>
    48      * @throws IOException if an error occurs during reading
     44     * @throws Exception if an error occurs during reading
    4945     */
    5046    @Test
    51     public void testTicket12694() throws IOException, XMLStreamException, FactoryConfigurationError {
     47    public void testTicket12694() throws Exception {
    5248        try (InputStream is = TestUtils.getRegressionDataStream(12694, "Alvinรณpolis_314946.kml")) {
    5349            NonRegFunctionalTests.testGeneric("#12694", KmlReader.parseDataSet(is, null));
    … …  
    5753    /**
    5854     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/10214">#10214</a>
    59      * @throws IOException if an error occurs during reading
     55     * @throws Exception if an error occurs during reading
    6056     */
    6157    @Test
    62     public void testTicket10214() throws IOException, XMLStreamException, FactoryConfigurationError {
     58    public void testTicket10214() throws Exception {
    6359        try (InputStream is = TestUtils.getRegressionDataStream(10214, "utf8_test.kml")) {
    6460            NonRegFunctionalTests.testTicket10214(KmlReader.parseDataSet(is, null));
    … …  
    6864    /**
    6965     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/7714">#7714</a>
    70      * @throws IOException if an error occurs during reading
     66     * @throws Exception if an error occurs during reading
    7167     */
    7268    @Test
    73     public void testTicket7714() throws IOException, XMLStreamException, FactoryConfigurationError {
     69    public void testTicket7714() throws Exception {
    7470        try (InputStream is = TestUtils.getRegressionDataStream(7714, "doc.kml")) {
    7571            NonRegFunctionalTests.testGeneric("#7714", KmlReader.parseDataSet(is, null));

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/geographic/ShpReaderTest.java

    r33156 r34153  
    88import java.io.File;
    99import java.io.FileInputStream;
    10 import java.io.IOException;
    1110import java.io.InputStream;
    12 
    13 import javax.xml.stream.FactoryConfigurationError;
    14 import javax.xml.stream.XMLStreamException;
    1511
    1612import org.junit.Ignore;
    … …  
    3632    /**
    3733     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/12714">#12714</a>
    38      * @throws IOException if an error occurs during reading
     34     * @throws Exception if an error occurs during reading
    3935     */
    4036    @Test
    41     public void testTicket12714() throws IOException, XMLStreamException, FactoryConfigurationError {
     37    public void testTicket12714() throws Exception {
    4238        File file = new File(TestUtils.getRegressionDataFile(12714, "linhas.shp"));
    4339        try (InputStream is = new FileInputStream(file)) {
    … …  
    5046    /**
    5147     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/11761">#11761</a>
    52      * @throws IOException if an error occurs during reading
     48     * @throws Exception if an error occurs during reading
    5349     */
    5450    @Test
    5551    @Ignore("work in progress")
    56     public void testTicket11761() throws IOException, XMLStreamException, FactoryConfigurationError {
     52    public void testTicket11761() throws Exception {
    5753        File file = new File(TestUtils.getRegressionDataFile(11761, "HAR.shp"));
    5854        try (InputStream is = new FileInputStream(file)) {
    … …  
    6864    /**
    6965     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/10214">#10214</a>
    70      * @throws IOException if an error occurs during reading
     66     * @throws Exception if an error occurs during reading
    7167     */
    7268    @Test
    73     public void testTicket10214() throws IOException, XMLStreamException, FactoryConfigurationError {
     69    public void testTicket10214() throws Exception {
    7470        File file = new File(TestUtils.getRegressionDataFile(10214, "utf8_test.shp"));
    7571        try (InputStream is = new FileInputStream(file)) {
    … …  
    8076    /**
    8177     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/8309">#8309</a>
    82      * @throws IOException if an error occurs during reading
     78     * @throws Exception if an error occurs during reading
    8379     */
    8480    @Test
    85     public void testTicket8309() throws IOException, XMLStreamException, FactoryConfigurationError {
     81    public void testTicket8309() throws Exception {
    8682        File file = new File(TestUtils.getRegressionDataFile(8309, "new_ti_declarada.shp"));
    8783        try (InputStream is = new FileInputStream(file)) {

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/geographic/TabReaderTest.java

    r33613 r34153  
    44import java.io.File;
    55import java.io.FileInputStream;
    6 import java.io.IOException;
    76import java.io.InputStream;
    8 
    9 import javax.xml.stream.FactoryConfigurationError;
    10 import javax.xml.stream.XMLStreamException;
    117
    128import org.junit.Rule;
    … …  
    2925    /**
    3026     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/15159">#15159</a>
    31      * @throws IOException if an error occurs during reading
     27     * @throws Exception if an error occurs during reading
    3228     */
    3329    @Test
    34     public void testTicket15159() throws IOException, XMLStreamException, FactoryConfigurationError {
     30    public void testTicket15159() throws Exception {
    3531        File file = new File(TestUtils.getRegressionDataFile(15159, "Sanisette.tab"));
    3632        try (InputStream is = new FileInputStream(file)) {

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/tabular/CsvReaderTest.java

    r33156 r34153  
    22package org.openstreetmap.josm.plugins.opendata.core.io.tabular;
    33
    4 import java.io.IOException;
    54import java.io.InputStream;
    6 
    7 import javax.xml.stream.FactoryConfigurationError;
    8 import javax.xml.stream.XMLStreamException;
    95
    106import org.junit.Rule;
    … …  
    5753    /**
    5854     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/13508">#13508</a>
    59      * @throws IOException if an error occurs during reading
     55     * @throws Exception if an error occurs during reading
    6056     */
    6157    @Test
    62     public void testTicket13508() throws IOException, XMLStreamException, FactoryConfigurationError {
     58    public void testTicket13508() throws Exception {
    6359        try (InputStream is = TestUtils.getRegressionDataStream(13508, "arrets-de-bus0.csv")) {
    6460            NonRegFunctionalTests.testGeneric("#13508", CsvReader.parseDataSet(is, newHandler("EPSG:4326"), null));
    … …  
    6864    /**
    6965     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/10214">#10214</a>
    70      * @throws IOException if an error occurs during reading
     66     * @throws Exception if an error occurs during reading
    7167     */
    7268    @Test
    73     public void testTicket10214() throws IOException, XMLStreamException, FactoryConfigurationError {
     69    public void testTicket10214() throws Exception {
    7470        try (InputStream is = TestUtils.getRegressionDataStream(10214, "utf8_test.csv")) {
    7571            NonRegFunctionalTests.testTicket10214(CsvReader.parseDataSet(is, newHandler("EPSG:4326"), null));
    … …  
    7975    /**
    8076     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/8805">#8805</a>
    81      * @throws IOException if an error occurs during reading
     77     * @throws Exception if an error occurs during reading
    8278     */
    8379    @Test
    84     public void testTicket8805() throws IOException, XMLStreamException, FactoryConfigurationError {
     80    public void testTicket8805() throws Exception {
    8581        try (InputStream is = TestUtils.getRegressionDataStream(8805, "XXX.csv")) {
    8682            NonRegFunctionalTests.testGeneric("#8805", CsvReader.parseDataSet(is, newHandler("EPSG:4326"), null));

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/tabular/OdsReaderTest.java

    r33156 r34153  
    22package org.openstreetmap.josm.plugins.opendata.core.io.tabular;
    33
    4 import java.io.IOException;
    54import java.io.InputStream;
    6 
    7 import javax.xml.stream.FactoryConfigurationError;
    8 import javax.xml.stream.XMLStreamException;
    95
    106import org.junit.Rule;
    … …  
    2723    /**
    2824     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/13821">#13821</a>
    29      * @throws IOException if an error occurs during reading
     25     * @throws Exception if an error occurs during reading
    3026     */
    3127    @Test
    32     public void testTicket13821() throws IOException, XMLStreamException, FactoryConfigurationError {
     28    public void testTicket13821() throws Exception {
    3329        try (InputStream is = TestUtils.getRegressionDataStream(13821, "1_set_v_0.6_2016_06_21_06_00_23_a.ods")) {
    3430            NonRegFunctionalTests.testGeneric("#13821", OdsReader.parseDataSet(is, null, null));

  • applications/editors/josm/plugins/opendata/test/unit/org/openstreetmap/josm/plugins/opendata/core/io/tabular/XlsReaderTest.java

    r34072 r34153  
    55import static org.junit.Assert.assertNotNull;
    66
    7 import java.io.IOException;
    87import java.io.InputStream;
    9 
    10 import javax.xml.stream.FactoryConfigurationError;
    11 import javax.xml.stream.XMLStreamException;
    128
    139import org.junit.Rule;
    … …  
    6157    /**
    6258     * Non-regression test for ticket <a href="https://josm.openstreetmap.de/ticket/15980">#15980</a>
    63      * @throws IOException if an error occurs during reading
     59     * @throws Exception if an error occurs during reading
    6460     */
    6561    @Test
    66     public void testTicket15980() throws IOException, XMLStreamException, FactoryConfigurationError {
     62    public void testTicket15980() throws Exception {
    6763        try (InputStream is = TestUtils.getRegressionDataStream(15980, "qry_OSM_Import_Orte.xls")) {
    6864            DataSet ds = XlsReader.parseDataSet(is, newHandler("EPSG:4326"), null);
Note: See TracChangeset for help on using the changeset viewer.