maplibre / maplibre-native

MapLibre Native - Interactive vector tile maps for iOS, Android and other platforms.
https://maplibre.org
BSD 2-Clause "Simplified" License
1.07k stars 317 forks source link

Dokka API docs missing docstrings #3021

Closed louwers closed 2 hours ago

louwers commented 2 hours ago

@sargunv observed that a lot of API documentation is missing all the documentation that is part of the docstrings.

https://maplibre.org/maplibre-native/android/api/-map-libre%20-native%20-android/org.maplibre.android.maps/-map-libre-map/add-on-map-click-listener.html?query=open%20fun%20addOnMapClickListener(listener:%20MapLibreMap.OnMapClickListener)

  /**
   * Interface definition for a callback to be invoked when the user clicks on the map view.
   *
   * @see MapLibreMap#addOnMapClickListener(OnMapClickListener)
   */
  public interface OnMapClickListener {
    /**
     * Called when the user clicks on the map view.
     *
     * @param point The projected map coordinate the user clicked on.
     * @return True if this click should be consumed and not passed further to other listeners registered afterwards,
     * false otherwise.
     */
    boolean onMapClick(@NonNull LatLng point);
  }
louwers commented 2 hours ago

Oh it's there.

You just have to click a few times. https://maplibre.org/maplibre-native/android/api/-map-libre%20-native%20-android/org.maplibre.android.maps/-map-libre-map/-on-map-click-listener/on-map-click.html

sargunv commented 58 minutes ago

Ah, nice, I didn't click into it far enough!