Skip to content

Commit 46f103c

Browse files
authored
docs: make android auto and carplay documentation part of the dart docs (#553)
1 parent 577d10f commit 46f103c

12 files changed

+46
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,8 +348,8 @@ await mapViewController.setMapColorScheme(MapColorScheme.dark);
348348
## Support for Android Auto and Apple CarPlay
349349
This plugin is compatible with both Android Auto and Apple CarPlay infotainment systems. For more details, please refer to the respective platform documentation:
350350

351-
- [Android Auto documentation](./ANDROIDAUTO.md)
352-
- [CarPlay documentation](./CARPLAY.md)
351+
- [Android Auto documentation](./doc/android-auto.md)
352+
- [CarPlay documentation](./doc/carplay.md)
353353

354354
## Known issues
355355

dartdoc_options.yaml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,20 @@ dartdoc:
2626
"Image Registry":
2727
markdown: doc/image-registry.md
2828
name: Image Registry
29-
categoryOrder: ["Navigation", "Navigation View", "Map View", "Image Registry"]
29+
"Android Auto":
30+
markdown: doc/android-auto.md
31+
name: Android Auto
32+
"Carplay":
33+
markdown: doc/carplay.md
34+
name: Carplay
35+
categoryOrder:
36+
[
37+
"Navigation",
38+
"Navigation View",
39+
"Map View",
40+
"Image Registry",
41+
"Android Auto",
42+
"Carplay",
43+
]
3044
showUndocumentedCategories: true
31-
nodoc: ['**/*.g.dart']
32-
45+
nodoc: ["**/*.g.dart"]
File renamed without changes.
File renamed without changes.

lib/src/google_maps_auto_view_controller.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ import 'package:flutter/widgets.dart';
1717
import '../google_navigation_flutter.dart';
1818
import 'google_navigation_flutter_platform_interface.dart';
1919

20+
/// {@category Android Auto}
21+
/// {@category Carplay}
2022
class GoogleMapsAutoViewController {
2123
GoogleMapsAutoViewController() {
2224
GoogleMapsNavigationPlatform.instance.autoAPI.ensureAutoViewApiSetUp();

lib/src/types/circles.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import '../utils/color.dart';
2121
/// Circle that has beed added to map.
2222
/// {@category Navigation View}
2323
/// {@category Map View}
24+
/// {@category Android Auto}
25+
/// {@category Carplay}
2426
@immutable
2527
class Circle {
2628
/// Construct [Circle].

lib/src/types/lat_lng.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import 'package:flutter/foundation.dart';
1818
/// {@category Navigation}
1919
/// {@category Navigation View}
2020
/// {@category Map View}
21+
/// {@category Android Auto}
22+
/// {@category Carplay}
2123
@immutable
2224
class LatLng {
2325
/// Initializes a [LatLng] with the provided latitude and longitude values.

lib/src/types/lat_lng_bounds.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ import '../../google_navigation_flutter.dart';
1919
/// LatLngBounds bounds object.
2020
/// {@category Navigation View}
2121
/// {@category Map View}
22+
/// {@category Android Auto}
23+
/// {@category Carplay}
2224
@immutable
2325
class LatLngBounds {
2426
/// Initialize LatLngBounds with the given southwest and northeast points.

lib/src/types/markers.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ import '../../google_navigation_flutter.dart';
1919
/// Marker that has beed added to the map.
2020
/// {@category Navigation View}
2121
/// {@category Map View}
22+
/// {@category Android Auto}
23+
/// {@category Carplay}
2224
@immutable
2325
class Marker {
2426
/// Construct [Marker]

lib/src/types/navigation_view_types.dart

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ class NavigationViewRecenterButtonClickedEvent {}
2323
/// Map type.
2424
/// {@category Navigation View}
2525
/// {@category Map View}
26+
/// {@category Android Auto}
27+
/// {@category Carplay}
2628
enum MapType {
2729
/// No type set.
2830
none,
@@ -76,6 +78,8 @@ enum NavigationForceNightMode {
7678
/// Represents the camera position in a Google Maps view.
7779
/// {@category Navigation View}
7880
/// {@category Map View}
81+
/// {@category Android Auto}
82+
/// {@category Carplay}
7983
class CameraPosition {
8084
/// Creates a [CameraPosition] object with map centered
8185
/// to the [target] with the given [bearing], [tilt] and [zoom] level.
@@ -123,6 +127,8 @@ class CameraPosition {
123127
/// to specify the orientation of the camera.
124128
/// {@category Navigation View}
125129
/// {@category Map View}
130+
/// {@category Android Auto}
131+
/// {@category Carplay}
126132
enum CameraPerspective {
127133
/// A tilted perspective facing in the same direction as the user.
128134
tilted,
@@ -134,6 +140,9 @@ enum CameraPerspective {
134140
topDownNorthUp,
135141
}
136142

143+
/// {@category Navigation}
144+
/// {@category Android Auto}
145+
/// {@category Carplay}
137146
class CustomNavigationAutoEvent {
138147
final String? event;
139148
final Object? data;
@@ -144,6 +153,9 @@ class CustomNavigationAutoEvent {
144153
String toString() => 'CustomNavigationAutoEvent(event: $event, data: $data)';
145154
}
146155

156+
/// {@category Navigation}
157+
/// {@category Android Auto}
158+
/// {@category Carplay}
147159
class AutoScreenAvailabilityChangedEvent {
148160
final bool isAvailable;
149161

@@ -347,6 +359,8 @@ enum CameraUpdateType {
347359
/// the current position.
348360
/// {@category Navigation View}
349361
/// {@category Map View}
362+
/// {@category Android Auto}
363+
/// {@category Carplay}
350364
class CameraUpdate {
351365
CameraUpdate._(this.type);
352366

0 commit comments

Comments
 (0)