Ignore:
Timestamp:
2013-04-14T22:20:20+02:00 (11 years ago)
Author:
stoecker
Message:

javadoc fixes

Location:
trunk/src/org/openstreetmap/josm/io
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/io/OsmImporter.java

    r5859 r5863  
    5353
    5454    /**
    55      * Imports OSM data from file @param file
    56      * This method supports progress monitoring and canceling by using @param progressMonitor
     55     * Imports OSM data from file
     56     * @param file file to read data from
     57     * @param progressMonitor handler for progress monitoring and canceling
    5758     */
    5859    @Override
    … …  
    7374
    7475    /**
    75      * Imports OSM data from stream @param in , sitle will be generated from name of file @param associatedFile
     76     * Imports OSM data from stream
     77     * @param in input stream
     78     * @param associatedFile filename of data
    7679     */
    7780    protected void importData(InputStream in, final File associatedFile) throws IllegalDataException {
    … …  
    8083   
    8184    /**
    82      * Imports OSM data from stream @param in , layer name will be generated from name of file @param associatedFile
    83      * This method supports progress monitoring and canceling by using @param progressMonitor
     85     * Imports OSM data from stream
     86     * @param in input stream
     87     * @param associatedFile filename of data (layer name will be generated from name of file)
     88     * @param pm handler for progress monitoring and canceling
    8489     */
    8590    protected void importData(InputStream in, final File associatedFile, ProgressMonitor pm) throws IllegalDataException {
    … …  
    100105    /**
    101106     * Load osm data layer from InputStream.
    102      * associatedFile can be null if the stream does not come from a file.
     107     * @param in input stream
     108     * @param associatedFile filename of data (can be <code>null</code> if the stream does not come from a file)
     109     * @param layerName name of generated layer
     110     * @param progressMonitor handler for progress monitoring and canceling
    103111     */
    104112    public OsmImporterData loadLayer(InputStream in, final File associatedFile, final String layerName, ProgressMonitor progressMonitor) throws IllegalDataException {

  • trunk/src/org/openstreetmap/josm/io/OsmServerReader.java

    r5587 r5863  
    3838     * Open a connection to the given url and return a reader on the input stream
    3939     * from that connection. In case of user cancel, return <code>null</code>.
    40      * @param urlStr The exact url to connect to.
    41      * @param pleaseWaitDlg
     40     * Relative URL's are directed to API base URL.
     41     * @param urlStr The url to connect to.
     42     * @param progressMonitor progress monitoring and abort handler
    4243     * @return An reader reading the input stream (servers answer) or <code>null</code>.
     44     * @throws OsmTransferException thrown if data transfer errors occur
    4345     */
    4446    protected InputStream getInputStream(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException  {
    … …  
    5254    }
    5355
     56    /**
     57     * Retrun the base URL for relative URL requests
     58     * @return base url of API
     59     */
    5460    protected String getBaseUrl() {
    5561        return api.getBaseUrl();
    5662    }
    5763
     64    /**
     65     * Open a connection to the given url and return a reader on the input stream
     66     * from that connection. In case of user cancel, return <code>null</code>.
     67     * @param urlStr The exact url to connect to.
     68     * @param progressMonitor progress monitoring and abort handler
     69     * @return An reader reading the input stream (servers answer) or <code>null</code>.
     70     * @throws OsmTransferException thrown if data transfer errors occur
     71     */
    5872    protected InputStream getInputStreamRaw(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException {
    5973        try {

  • trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java

    r5692 r5863  
    1515
    1616    /**
    17      * @see CredentialsAgent#getCredentials(RequestorType, String, boolean)
     17     * @see CredentialsAgent#getCredentials
    1818     */
    1919    @Override

  • trunk/src/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgent.java

    r5111 r5863  
    2525
    2626    /**
    27      * @see CredentialsAgent#lookup(RequestorType)
     27     * @see CredentialsAgent#lookup
    2828     */
    2929    @Override
    … …  
    5959
    6060    /**
    61      * @see CredentialsAgent#store(RequestorType, PasswordAuthentication)
     61     * @see CredentialsAgent#store
    6262     */
    6363    @Override
Note: See TracChangeset for help on using the changeset viewer.