Referencing innerclasses directly. Only then links in Javadoc show up. GeoSPI
authorJaroslav Tulach <jtulach@netbeans.org>
Wed, 27 Aug 2014 18:44:16 +0200
branchGeoSPI
changeset 8450a7a5a880e6d
parent 844 cdc17834e71c
child 846 131f27ce1282
Referencing innerclasses directly. Only then links in Javadoc show up.
geo/src/main/java/org/netbeans/html/geo/spi/GLProvider.java
     1.1 --- a/geo/src/main/java/org/netbeans/html/geo/spi/GLProvider.java	Wed Aug 27 18:39:23 2014 +0200
     1.2 +++ b/geo/src/main/java/org/netbeans/html/geo/spi/GLProvider.java	Wed Aug 27 18:44:16 2014 +0200
     1.3 @@ -45,6 +45,8 @@
     1.4  
     1.5  import net.java.html.BrwsrCtx;
     1.6  import net.java.html.geo.Position;
     1.7 +import net.java.html.geo.Position.Handle;
     1.8 +import net.java.html.geo.Position.Coordinates;
     1.9  import org.netbeans.html.context.spi.Contexts;
    1.10  import org.openide.util.lookup.ServiceProvider;
    1.11  
    1.12 @@ -102,20 +104,20 @@
    1.13   */
    1.14  public abstract class GLProvider<Coords,Watch> {
    1.15      /** Start obtaining geolocation.
    1.16 -     * When the client {@link Position.Handle#start() requests location} (and
    1.17 +     * When the client {@link Handle#start() requests location} (and
    1.18       * your provider is found) this method should initialize the request or 
    1.19       * return <code>null</code> to give chance to another provider.
    1.20       * 
    1.21       * @param c the callback to {@link #callback(org.netbeans.html.geo.spi.GLProvider.Callback, long, java.lang.Object, java.lang.Exception) use when location is found} -
    1.22       *    keep it, you'll need it later
    1.23       * @param oneTime one time request vs. repeated requests
    1.24 -     *    - mimics value provided in {@link Position.Handle#Handle(boolean) constructor}
    1.25 +     *    - mimics value provided in {@link Handle#Handle(boolean) constructor}
    1.26       * @param enableHighAccuracy mimics value of
    1.27 -     *    {@link Position.Handle#setHighAccuracy(boolean)}
    1.28 +     *    {@link Handle#setHighAccuracy(boolean)}
    1.29       * @param timeout mimics value of
    1.30 -     *    {@link Position.Handle#setTimeout(long)}
    1.31 +     *    {@link Handle#setTimeout(long)}
    1.32       * @param maximumAge mimics value of 
    1.33 -     *    {@link Position.Handle#setMaximumAge(long)}
    1.34 +     *    {@link Handle#setMaximumAge(long)}
    1.35       * 
    1.36       * @return an object representing the request (so it can be {@link #stop(java.lang.Object) stopped} later)
    1.37       *   or <code>null</code> if this provider was unable to start the request
    1.38 @@ -137,8 +139,8 @@
    1.39       * This single method is used for notification of success (when <code>ex</code>
    1.40       * argument is <code>null</code> and <code>position</code> is provided) or 
    1.41       * a failure (when <code>ex</code> argument is non-<code>null</code>).
    1.42 -     * A successful requests leads in call to {@link Position.Handle#onLocation(net.java.html.geo.Position)}
    1.43 -     * while an error report leads to call to {@link Position.Handle#onError(java.lang.Exception)}.
    1.44 +     * A successful requests leads in call to {@link Handle#onLocation(net.java.html.geo.Position)}
    1.45 +     * while an error report leads to call to {@link Handle#onError(java.lang.Exception)}.
    1.46       * 
    1.47       * @param c the callback as provided when {@link #start(org.netbeans.html.geo.spi.GLProvider.Callback, boolean, boolean, long, long) starting}
    1.48       *   the request
    1.49 @@ -162,19 +164,19 @@
    1.50          }
    1.51      }
    1.52  
    1.53 -    /** Extracts value for {@link Position.Coordinates#getLatitude()}.
    1.54 +    /** Extracts value for {@link Coordinates#getLatitude()}.
    1.55       * @param coords your own internal representation of coordinates.
    1.56       * @return geographic coordinate specified in decimal degrees.
    1.57       */
    1.58      protected abstract double latitude(Coords coords);
    1.59      
    1.60 -    /** Extracts value for {@link Position.Coordinates#getLatitude()}.
    1.61 +    /** Extracts value for {@link Coordinates#getLatitude()}.
    1.62       * @param coords your own internal representation of coordinates.
    1.63       * @return geographic coordinate specified in decimal degrees.
    1.64       */
    1.65      protected abstract double longitude(Coords coords);
    1.66      
    1.67 -    /** Extracts value for {@link Position.Coordinates#getLatitude()}.
    1.68 +    /** Extracts value for {@link Coordinates#getLatitude()}.
    1.69       * The accuracy attribute denotes the accuracy level of the latitude 
    1.70       * and longitude coordinates.
    1.71       * 
    1.72 @@ -183,7 +185,7 @@
    1.73       */
    1.74      protected abstract double accuracy(Coords coords);
    1.75      
    1.76 -    /** Extracts value for {@link Position.Coordinates#getAltitude()}.
    1.77 +    /** Extracts value for {@link Coordinates#getAltitude()}.
    1.78       * Denotes the height of the position, specified in meters above the ellipsoid.
    1.79       * 
    1.80       * @param coords your own internal representation of coordinates.
    1.81 @@ -191,7 +193,7 @@
    1.82       */
    1.83      protected abstract Double altitude(Coords coords);
    1.84      
    1.85 -    /** Extracts value for {@link Position.Coordinates#getAltitudeAccuracy()} -
    1.86 +    /** Extracts value for {@link Coordinates#getAltitudeAccuracy()} -
    1.87       * the altitude accuracy is specified in meters. 
    1.88       * 
    1.89       * @param coords your own internal representation of coordinates.
    1.90 @@ -199,7 +201,7 @@
    1.91       */
    1.92      protected abstract Double altitudeAccuracy(Coords coords);
    1.93      
    1.94 -    /** Extracts value for {@link Position.Coordinates#getHeading()}.
    1.95 +    /** Extracts value for {@link Coordinates#getHeading()}.
    1.96       * Denotes the magnitude of the horizontal component of the 
    1.97       * device's current velocity and is specified in meters per second.
    1.98       * 
    1.99 @@ -208,7 +210,7 @@
   1.100       */
   1.101      protected abstract Double heading(Coords coords);
   1.102      
   1.103 -    /** Extracts value for {@link Position.Coordinates#getSpeed()}.
   1.104 +    /** Extracts value for {@link Coordinates#getSpeed()}.
   1.105       * Denotes the magnitude of the horizontal component of the 
   1.106       * device's current velocity and is specified in meters per second.
   1.107       * 
   1.108 @@ -233,13 +235,13 @@
   1.109          /** Initiates a geolocation request. 
   1.110           * 
   1.111           * @param oneTime one time request vs. repeated requests
   1.112 -         *    - mimics value provided in {@link Position.Handle#Handle(boolean) constructor}
   1.113 +         *    - mimics value provided in {@link Handle#Handle(boolean) constructor}
   1.114           * @param enableHighAccuracy mimics value of
   1.115 -         *    {@link Position.Handle#setHighAccuracy(boolean)}
   1.116 +         *    {@link Handle#setHighAccuracy(boolean)}
   1.117           * @param timeout mimics value of
   1.118 -         *    {@link Position.Handle#setTimeout(long)}
   1.119 +         *    {@link Handle#setTimeout(long)}
   1.120           * @param maximumAge mimics value of 
   1.121 -         *    {@link Position.Handle#setMaximumAge(long)}
   1.122 +         *    {@link Handle#setMaximumAge(long)}
   1.123           * @return an object representing the request (so it can be {@link #stop(java.lang.Object) stopped} later)
   1.124           *   or <code>null</code> if this provider was unable to start the request
   1.125           */