Skip to content
This repository has been archived by the owner on Nov 11, 2024. It is now read-only.

Commit

Permalink
Documentation change only: minor fixes to uGeofence API descriptions.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobMeades committed Nov 5, 2023
1 parent d9f266d commit 99b6f24
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions common/geofence/api/u_geofence.h
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ int32_t uGeofenceAddCircle(uGeofence_t *pFence,
* The geofence does not become active until one of
* uGnssGeofenceApply(), uCellGeofenceApply() or uWifiGeofenceApply()
* is called; once a geofence is applied to one or more devices
* uGeofenceAddCircle() cannot be called on it again until the
* uGeofenceAddVertex() cannot be called on it again until the
* geofence is removed from those instances by a call to
* uGnssGeofenceRemove(), uCellGeofenceRemove() or
* uWifiGeofenceRemove().
Expand Down Expand Up @@ -449,8 +449,9 @@ int32_t uGeofenceAddVertex(uGeofence_t *pFence,

/** Set the maximum altitude of a geofence; if this is not called there
* is no maximum altitude. If the geofence is currently applied to any
* devices an error will be returned; call uGeofenceRemove() to remove
* it from those devices first.
* devices an error will be returned; call uGnssGeofenceRemove(),
* uCellGeofenceRemove() or uWifiGeofenceRemove() to remove it from
* those device(s) first.
*
* IMPORTANT: if a maximum altitude is set but only 2D position is
* achieved then that position will be IGNORED for this geofence; do
Expand Down

0 comments on commit 99b6f24

Please sign in to comment.