Skip to content

Commit 8a96de0

Browse files
committed
WiFi: align comments
1 parent 53fc01b commit 8a96de0

File tree

1 file changed

+60
-60
lines changed

1 file changed

+60
-60
lines changed

Diff for: libraries/WiFi/src/WiFi.h

+60-60
Original file line numberDiff line numberDiff line change
@@ -55,27 +55,27 @@ class WiFiClass : public MbedSocketClass {
5555
: wifi_if(_if){};
5656

5757
/*
58-
* Get firmware version
59-
*/
58+
* Get firmware version
59+
*/
6060
static const char* firmwareVersion();
6161

6262
/* Start Wifi connection for OPEN networks
63-
*
64-
* param ssid: Pointer to the SSID string.
65-
*/
63+
*
64+
* param ssid: Pointer to the SSID string.
65+
*/
6666
int begin(const char* ssid);
6767

6868
void MACAddress(uint8_t *mac_address);
6969

7070
/* Start Wifi connection with passphrase
71-
* the most secure supported mode will be automatically selected
72-
*
73-
* param ssid: Pointer to the SSID string.
74-
* param passphrase: Passphrase. Valid characters in a passphrase
75-
* must be between ASCII 32-126 (decimal).
76-
*/
71+
* the most secure supported mode will be automatically selected
72+
*
73+
* param ssid: Pointer to the SSID string.
74+
* param passphrase: Passphrase. Valid characters in a passphrase
75+
* must be between ASCII 32-126 (decimal).
76+
*/
7777
int begin(const char* ssid, const char* passphrase, wl_enc_type security = ENC_TYPE_UNKNOWN);
78-
78+
7979
// Inherit config methods from the parent class
8080
using MbedSocketClass::config;
8181

@@ -84,86 +84,86 @@ class WiFiClass : public MbedSocketClass {
8484
int beginAP(const char* ssid, const char* passphrase, uint8_t channel = DEFAULT_AP_CHANNEL);
8585

8686
/*
87-
* Disconnect from the network
88-
*
89-
* return: one value of wl_status_t enum
90-
*/
87+
* Disconnect from the network
88+
*
89+
* return: one value of wl_status_t enum
90+
*/
9191
int disconnect(void);
9292

9393
void end(void);
9494

9595
/*
96-
* Return the current SSID associated with the network
97-
*
98-
* return: ssid string
99-
*/
96+
* Return the current SSID associated with the network
97+
*
98+
* return: ssid string
99+
*/
100100
char* SSID();
101101

102102
/*
103-
* Return the current BSSID associated with the network.
104-
* It is the MAC address of the Access Point
105-
*
106-
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
107-
*/
103+
* Return the current BSSID associated with the network.
104+
* It is the MAC address of the Access Point
105+
*
106+
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
107+
*/
108108
uint8_t* BSSID(uint8_t* bssid);
109109

110110
/*
111-
* Return the current RSSI /Received Signal Strength in dBm)
112-
* associated with the network
113-
*
114-
* return: signed value
115-
*/
111+
* Return the current RSSI /Received Signal Strength in dBm)
112+
* associated with the network
113+
*
114+
* return: signed value
115+
*/
116116
int32_t RSSI();
117117

118118
/*
119-
* Return the Encryption Type associated with the network
120-
*
121-
* return: one value of wl_enc_type enum
122-
*/
119+
* Return the Encryption Type associated with the network
120+
*
121+
* return: one value of wl_enc_type enum
122+
*/
123123
uint8_t encryptionType();
124124

125125
/*
126-
* Start scan WiFi networks available
127-
*
128-
* return: Number of discovered networks
129-
*/
126+
* Start scan WiFi networks available
127+
*
128+
* return: Number of discovered networks
129+
*/
130130
int8_t scanNetworks();
131131

132132
/*
133-
* Return the SSID discovered during the network scan.
134-
*
135-
* param networkItem: specify from which network item want to get the information
136-
*
137-
* return: ssid string of the specified item on the networks scanned list
138-
*/
133+
* Return the SSID discovered during the network scan.
134+
*
135+
* param networkItem: specify from which network item want to get the information
136+
*
137+
* return: ssid string of the specified item on the networks scanned list
138+
*/
139139
char* SSID(uint8_t networkItem);
140140

141141
/*
142-
* Return the encryption type of the networks discovered during the scanNetworks
143-
*
144-
* param networkItem: specify from which network item want to get the information
145-
*
146-
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
147-
*/
142+
* Return the encryption type of the networks discovered during the scanNetworks
143+
*
144+
* param networkItem: specify from which network item want to get the information
145+
*
146+
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
147+
*/
148148
uint8_t encryptionType(uint8_t networkItem);
149149

150150
uint8_t* BSSID(uint8_t networkItem, uint8_t* bssid);
151151
uint8_t channel(uint8_t networkItem);
152152

153153
/*
154-
* Return the RSSI of the networks discovered during the scanNetworks
155-
*
156-
* param networkItem: specify from which network item want to get the information
157-
*
158-
* return: signed value of RSSI of the specified item on the networks scanned list
159-
*/
154+
* Return the RSSI of the networks discovered during the scanNetworks
155+
*
156+
* param networkItem: specify from which network item want to get the information
157+
*
158+
* return: signed value of RSSI of the specified item on the networks scanned list
159+
*/
160160
int32_t RSSI(uint8_t networkItem);
161161

162162
/*
163-
* Return Connection status.
164-
*
165-
* return: one of the value defined in wl_status_t
166-
*/
163+
* Return Connection status.
164+
*
165+
* return: one of the value defined in wl_status_t
166+
*/
167167
uint8_t status();
168168

169169
unsigned long getTime();

0 commit comments

Comments
 (0)