Skip to content

Commit 414d5e3

Browse files
committed
Update documentation
1 parent 8503873 commit 414d5e3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: docs/api.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
`class ` [`ModemInterface`](#class_modem_interface) | Represents the interface to the 4G modem module which extends the TinyGsmBG96 class.
77
`class ` [`SMS`](#class_s_m_s) | Represents an [SMS](#class_s_m_s) message.
88
`class ` [`Time`](#class_time) | Represents a point in time with year, month, day, hour, minute, second, and offset.
9-
`struct ` [`Geolocation`](#struct_location) | Represents a geographic location with latitude and longitude coordinates.
9+
`struct ` [`Geolocation`](#struct_geolocation) | Represents a geographic location with latitude and longitude coordinates.
1010

1111
# class `ArduinoCellular` <a id="class_arduino_cellular" class="anchor"></a>
1212

@@ -23,7 +23,7 @@ This class provides methods to interact with the Arduino Pro Modem, such as conn
2323
| [`isConnectedToOperator`](#class_arduino_cellular_1af7453ef90702e9042e2b4b18fa89db03) | Checks if the modem is registered on the network. |
2424
| [`isConnectedToInternet`](#class_arduino_cellular_1a6f8251e06de1810897b8bd8f8fb1b1a2) | Checks if the GPRS network is connected. |
2525
| [`enableGPS`](#class_arduino_cellular_1abe77a53e0eba6e8d62ba5db3bb6f5e92) | Enables or disables the GPS functionality. |
26-
| [`getGPSLocation`](#class_arduino_cellular_1aee57a2eec5be06172b2fb7cd574d9106) | Gets the GPS location. (Blocking call) |
26+
| [`getGPSLocation`](#class_arduino_cellular_1a41225f52d059df173f028ecd0c039ec3) | Gets the GPS location. (Blocking call) |
2727
| [`getCellularTime`](#class_arduino_cellular_1a6b3ce5485badff582584d539e790aff4) | Gets the current time from the network. |
2828
| [`getGPSTime`](#class_arduino_cellular_1a4aeb898c958e6eb001d606f0c7da8799) | Gets the current time from the GPS module. |
2929
| [`sendSMS`](#class_arduino_cellular_1a371aef1318857f0863f443eaeabf4ac2) | Sends an [SMS](#class_s_m_s) message to the specified number. |
@@ -135,10 +135,10 @@ Enables or disables the GPS functionality.
135135
True if GPS was enabled successfully, false otherwise.
136136
<hr />
137137
138-
### `getGPSLocation` <a id="class_arduino_cellular_1aee57a2eec5be06172b2fb7cd574d9106" class="anchor"></a>
138+
### `getGPSLocation` <a id="class_arduino_cellular_1a41225f52d059df173f028ecd0c039ec3" class="anchor"></a>
139139
140140
```cpp
141-
CellularLocation getGPSLocation(unsigned long timeout)
141+
Geolocation getGPSLocation(unsigned long timeout)
142142
```
143143

144144
Gets the GPS location. (Blocking call)
@@ -824,20 +824,20 @@ Returns the timezone offset of the time.
824824
The timezone offset of the time.
825825
<hr />
826826

827-
# struct `Geolocation` <a id="struct_location" class="anchor"></a>
827+
# struct `Geolocation` <a id="struct_geolocation" class="anchor"></a>
828828

829829
Represents a geographic location with latitude and longitude coordinates.
830830

831831
## Summary
832832

833833
Members | Descriptions
834834
--------------------------------|---------------------------------------------
835-
| [`latitude`](#struct_location_1a194bf3edf130d2a4bf281720e7d01409) | The latitude coordinate of the location. |
836-
| [`longitude`](#struct_location_1ae36169ef2dfcad63e26b492a6a82b990) | The longitude coordinate of the location. |
835+
| [`latitude`](#struct_geolocation_1a86c7bea43545766d1da49a566b579846) | The latitude coordinate of the location. |
836+
| [`longitude`](#struct_geolocation_1a6df627e2a4f3566e7a40cec69c94fd06) | The longitude coordinate of the location. |
837837

838838
## Members
839839

840-
### `latitude` <a id="struct_location_1a194bf3edf130d2a4bf281720e7d01409" class="anchor"></a>
840+
### `latitude` <a id="struct_geolocation_1a86c7bea43545766d1da49a566b579846" class="anchor"></a>
841841

842842
```cpp
843843
float latitude
@@ -846,7 +846,7 @@ float latitude
846846
The latitude coordinate of the location.
847847
<hr />
848848

849-
### `longitude` <a id="struct_location_1ae36169ef2dfcad63e26b492a6a82b990" class="anchor"></a>
849+
### `longitude` <a id="struct_geolocation_1a6df627e2a4f3566e7a40cec69c94fd06" class="anchor"></a>
850850

851851
```cpp
852852
float longitude

0 commit comments

Comments
 (0)