Changeset 5863 in josm for trunk/src/org/openstreetmap/josm/io/OsmServerReader.java

Timestamp:

2013-04-14T22:20:20+02:00 (13 years ago)

Author:

stoecker

Message:

javadoc fixes

File:

• trunk/src/org/openstreetmap/josm/io/OsmServerReader.java (modified) (2 diffs)

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

@@ -38 +38 @@
      * Open a connection to the given url and return a reader on the input stream
      * from that connection. In case of user cancel, return <code>null</code>.
-     * @param urlStr The exact url to connect to.
-     * @param pleaseWaitDlg
+     * Relative URL's are directed to API base URL.
+     * @param urlStr The url to connect to.
+     * @param progressMonitor progress monitoring and abort handler
      * @return An reader reading the input stream (servers answer) or <code>null</code>.
+     * @throws OsmTransferException thrown if data transfer errors occur
      */
     protected InputStream getInputStream(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException  {
@@ -52 +54 @@
     }
 
+    /**
+     * Retrun the base URL for relative URL requests
+     * @return base url of API
+     */
     protected String getBaseUrl() {
         return api.getBaseUrl();
     }
 
+    /**
+     * Open a connection to the given url and return a reader on the input stream
+     * from that connection. In case of user cancel, return <code>null</code>.
+     * @param urlStr The exact url to connect to.
+     * @param progressMonitor progress monitoring and abort handler
+     * @return An reader reading the input stream (servers answer) or <code>null</code>.
+     * @throws OsmTransferException thrown if data transfer errors occur
+     */
     protected InputStream getInputStreamRaw(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException {
         try {