docs: make android auto and carplay documentation part of the dart docs (#553)

Author: jokerttu

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
 

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"]

ANDROIDAUTO.md doc/android-auto.mdANDROIDAUTO.md renamed to doc/android-auto.md

@@ -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();

CARPLAY.MD doc/carplay.mdCARPLAY.MD renamed to doc/carplay.md

@@ -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].

lib/src/google_maps_auto_view_controller.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.

lib/src/types/circles.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.

lib/src/types/lat_lng.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]

lib/src/types/lat_lng_bounds.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);