CellularBase update #428
Merged
CellularBase update #428
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@AnotherButler, @AnttiKauppila please review |
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| The CellularBase provides a C++ API for connecting to the internet over a Cellular device. | |||
|
|
|||
| Arm Mbed OS provides a [reference implementation of CellularBase](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver), which has more information. | |||
| Arm Mbed OS provides a [reference implementation of CellularBase](https://github.com/ARMmbed/mbed-os/tree/master/features/cellular/easy_cellular), which has more information. | |||
There was a problem hiding this comment.
Please use https://github.com/ARMmbed/mbed-os/pull/6280/files as an example to make the Doxygen render.
| @@ -14,7 +14,7 @@ To bring up the network interface: | |||
|
|
|||
| 1. Instantiate an implementation of the CellularBase class. | |||
| 1. Call the `connect(pincode, apn)` function with a PIN code for your SIM card and an APN for your network. | |||
| 1. Once connected, you can use Mbed OS [network sockets](/docs/v5.7/reference/network-socket.html) as usual. | |||
| 1. Once connected, you can use Mbed OS [network sockets](https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/networksocket.md) as usual. | |||
There was a problem hiding this comment.
Query: Can we still link to the os.mbed.com/docs page now that you've updated it? Is there something in the GitHub page that we need that's not in the old link?
| @@ -24,4 +24,4 @@ This example establishes connection with the cellular network using Mbed OS Cell | |||
|
|
|||
| ### Related content | |||
|
|
|||
| - [Network socket](/docs/v5.7/reference/network-socket.html) API reference overview. | |||
| - [Network socket](https://github.com/ARMmbed/Handbook/blob/new_engine/docs/reference/api/connectivity/networksocket/networksocket.md) API reference overview. | |||
There was a problem hiding this comment.
Query: Can we still link to the os.mbed.com/docs page now that you've updated it? Is there something in the GitHub page that we need that's not in the old link?
Update links to point to more precise location.
Update links because the engine is particular.
AnotherButler
approved these changes
Mar 12, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.