diff --git a/README.md b/README.md index 9cf81cab..ceeca4a0 100644 --- a/README.md +++ b/README.md @@ -348,8 +348,8 @@ await mapViewController.setMapColorScheme(MapColorScheme.dark); ## Support for Android Auto and Apple CarPlay This plugin is compatible with both Android Auto and Apple CarPlay infotainment systems. For more details, please refer to the respective platform documentation: -- [Android Auto documentation](./ANDROIDAUTO.md) -- [CarPlay documentation](./CARPLAY.md) +- [Android Auto documentation](./doc/android-auto.md) +- [CarPlay documentation](./doc/carplay.md) ## Known issues diff --git a/dartdoc_options.yaml b/dartdoc_options.yaml index 9e491353..e94d24a7 100644 --- a/dartdoc_options.yaml +++ b/dartdoc_options.yaml @@ -26,7 +26,20 @@ dartdoc: "Image Registry": markdown: doc/image-registry.md name: Image Registry - categoryOrder: ["Navigation", "Navigation View", "Map View", "Image Registry"] + "Android Auto": + markdown: doc/android-auto.md + name: Android Auto + "Carplay": + markdown: doc/carplay.md + name: Carplay + categoryOrder: + [ + "Navigation", + "Navigation View", + "Map View", + "Image Registry", + "Android Auto", + "Carplay", + ] showUndocumentedCategories: true - nodoc: ['**/*.g.dart'] - + nodoc: ["**/*.g.dart"] diff --git a/ANDROIDAUTO.md b/doc/android-auto.md similarity index 100% rename from ANDROIDAUTO.md rename to doc/android-auto.md diff --git a/CARPLAY.MD b/doc/carplay.md similarity index 100% rename from CARPLAY.MD rename to doc/carplay.md diff --git a/lib/src/google_maps_auto_view_controller.dart b/lib/src/google_maps_auto_view_controller.dart index 8d086628..f69cdac1 100644 --- a/lib/src/google_maps_auto_view_controller.dart +++ b/lib/src/google_maps_auto_view_controller.dart @@ -17,6 +17,8 @@ import 'package:flutter/widgets.dart'; import '../google_navigation_flutter.dart'; import 'google_navigation_flutter_platform_interface.dart'; +/// {@category Android Auto} +/// {@category Carplay} class GoogleMapsAutoViewController { GoogleMapsAutoViewController() { GoogleMapsNavigationPlatform.instance.autoAPI.ensureAutoViewApiSetUp(); diff --git a/lib/src/types/circles.dart b/lib/src/types/circles.dart index 5ce0554d..690143e5 100644 --- a/lib/src/types/circles.dart +++ b/lib/src/types/circles.dart @@ -21,6 +21,8 @@ import '../utils/color.dart'; /// Circle that has beed added to map. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} @immutable class Circle { /// Construct [Circle]. diff --git a/lib/src/types/lat_lng.dart b/lib/src/types/lat_lng.dart index a5e8cd8f..137c49dc 100644 --- a/lib/src/types/lat_lng.dart +++ b/lib/src/types/lat_lng.dart @@ -18,6 +18,8 @@ import 'package:flutter/foundation.dart'; /// {@category Navigation} /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} @immutable class LatLng { /// Initializes a [LatLng] with the provided latitude and longitude values. diff --git a/lib/src/types/lat_lng_bounds.dart b/lib/src/types/lat_lng_bounds.dart index 25e1d243..cce3eab8 100644 --- a/lib/src/types/lat_lng_bounds.dart +++ b/lib/src/types/lat_lng_bounds.dart @@ -19,6 +19,8 @@ import '../../google_navigation_flutter.dart'; /// LatLngBounds bounds object. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} @immutable class LatLngBounds { /// Initialize LatLngBounds with the given southwest and northeast points. diff --git a/lib/src/types/markers.dart b/lib/src/types/markers.dart index f2284ae0..fd43f5c1 100644 --- a/lib/src/types/markers.dart +++ b/lib/src/types/markers.dart @@ -19,6 +19,8 @@ import '../../google_navigation_flutter.dart'; /// Marker that has beed added to the map. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} @immutable class Marker { /// Construct [Marker] diff --git a/lib/src/types/navigation_view_types.dart b/lib/src/types/navigation_view_types.dart index ed6c819a..e12298a9 100644 --- a/lib/src/types/navigation_view_types.dart +++ b/lib/src/types/navigation_view_types.dart @@ -23,6 +23,8 @@ class NavigationViewRecenterButtonClickedEvent {} /// Map type. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} enum MapType { /// No type set. none, @@ -76,6 +78,8 @@ enum NavigationForceNightMode { /// Represents the camera position in a Google Maps view. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} class CameraPosition { /// Creates a [CameraPosition] object with map centered /// to the [target] with the given [bearing], [tilt] and [zoom] level. @@ -123,6 +127,8 @@ class CameraPosition { /// to specify the orientation of the camera. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} enum CameraPerspective { /// A tilted perspective facing in the same direction as the user. tilted, @@ -134,6 +140,9 @@ enum CameraPerspective { topDownNorthUp, } +/// {@category Navigation} +/// {@category Android Auto} +/// {@category Carplay} class CustomNavigationAutoEvent { final String? event; final Object? data; @@ -144,6 +153,9 @@ class CustomNavigationAutoEvent { String toString() => 'CustomNavigationAutoEvent(event: $event, data: $data)'; } +/// {@category Navigation} +/// {@category Android Auto} +/// {@category Carplay} class AutoScreenAvailabilityChangedEvent { final bool isAvailable; @@ -347,6 +359,8 @@ enum CameraUpdateType { /// the current position. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} class CameraUpdate { CameraUpdate._(this.type); diff --git a/lib/src/types/polygons.dart b/lib/src/types/polygons.dart index 0832d15b..fa32d293 100644 --- a/lib/src/types/polygons.dart +++ b/lib/src/types/polygons.dart @@ -22,6 +22,8 @@ import '../utils/color.dart'; /// Polygon that has beed added to map. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} @immutable class Polygon { /// Construct [Polygon]. diff --git a/lib/src/types/polylines.dart b/lib/src/types/polylines.dart index 9f4e0be9..72841f84 100644 --- a/lib/src/types/polylines.dart +++ b/lib/src/types/polylines.dart @@ -21,6 +21,8 @@ import '../utils/color.dart'; /// Polyline that has beed added to map. /// {@category Navigation View} /// {@category Map View} +/// {@category Android Auto} +/// {@category Carplay} @immutable class Polyline { /// Construct [Polyline].