add comments

RiotSwiftUI/Modules/LocationSharing/LiveLocationSharingViewer/LiveLocationSharingViewerModels.swift

@@ -42,6 +42,7 @@ struct LiveLocationSharingViewerViewState: BindableState {
  /// Live location list items
  var listItemsViewData: [LiveLocationListItemViewData]
 
+ /// Behavior mode of the current user's location, can be hidden, only shown and shown following the user
  var showsUserLocationMode: ShowUserLocationMode = .hide
 
  var isCurrentUserShared: Bool {

RiotSwiftUI/Modules/LocationSharing/LiveLocationSharingViewer/LiveLocationSharingViewerViewModel.swift

@@ -210,6 +210,12 @@ class LiveLocationSharingViewerViewModel: LiveLocationSharingViewerViewModelType
  guard let foundUserAnnotation = foundUserAnnotation else {
  return
  }
+
+ /*
+ if the map is currently following the current user's location,
+ we want to switch back to only showing the marker,
+ so the the highlited shared location can be centered
+ */
  if state.showsUserLocationMode == .follow {
  state.showsUserLocationMode = .show
  }

RiotSwiftUI/Modules/LocationSharing/MapView/View/LocationSharingMapView.swift

@@ -18,6 +18,9 @@ import Combine
 import Mapbox
 import SwiftUI
 
+/*
+ Behavior mode of the current user's location, can be hidden, only shown and shown following the user
+ */
 enum ShowUserLocationMode {
  case follow
  case show
@@ -45,7 +48,7 @@ struct LocationSharingMapView: UIViewRepresentable {
  /// Current user avatar data, used to replace current location annotation view with the user avatar
  let userAvatarData: AvatarInputProtocol?
 
- /// True to indicate to show and follow current user location
+ /// Behavior mode of the current user's location, can be hidden, only shown and shown following the user
  var showsUserLocationMode: ShowUserLocationMode = .hide
 
  /// True to indicate that a touch on user annotation can show a callout
@@ -81,6 +84,11 @@ struct LocationSharingMapView: UIViewRepresentable {
  mapView.vc_removeAllAnnotations()
  mapView.addAnnotations(annotations)
 
+ /*
+ if there is an highlighted annotation,
+ and the current user's location it's either hidden or only shown,
+ we can center to the highlighted annotation
+ */
  if let highlightedAnnotation = highlightedAnnotation, showsUserLocationMode != .follow {
  mapView.setCenter(highlightedAnnotation.coordinate, zoomLevel: Constants.mapZoomLevel, animated: true)
  }

RiotSwiftUI/Modules/LocationSharing/StartLocationSharing/LocationSharingModels.swift

@@ -80,7 +80,7 @@ struct LocationSharingViewState: BindableState {
 
  var showLoadingIndicator = false
 
- /// True to indicate to show and follow current user location
+ /// Behavior mode of the current user's location, can be hidden, only shown and shown following the user
  var showsUserLocationMode: ShowUserLocationMode = .hide
 
  /// Used to hide live location sharing features

RiotSwiftUI/Modules/LocationSharing/StaticLocationSharingViewer/StaticLocationViewingModels.swift

@@ -43,6 +43,7 @@ struct StaticLocationViewingViewState: BindableState {
  /// Shared annotation to display existing location
  let sharedAnnotation: LocationAnnotation
 
+ /// Behavior mode of the current user's location, can be hidden, only shown and shown following the user
  var showsUserLocationMode: ShowUserLocationMode = .hide
 
  var showLoadingIndicator = false