Skip to content

Commit 7ab565e

Browse files
committed
WiFi: align comments
1 parent 76990a7 commit 7ab565e

File tree

1 file changed

+60
-60
lines changed

1 file changed

+60
-60
lines changed

libraries/WiFi/src/WiFi.h

+60-60
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,14 @@ 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
/*
@@ -74,14 +74,14 @@ class WiFiClass : public MbedSocketClass {
7474
void MACAddress(uint8_t *mac_address) __attribute__ ((deprecated("Use macAddress(uint8_t *mac_address)")));
7575

7676
/* Start Wifi connection with passphrase
77-
* the most secure supported mode will be automatically selected
78-
*
79-
* param ssid: Pointer to the SSID string.
80-
* param passphrase: Passphrase. Valid characters in a passphrase
81-
* must be between ASCII 32-126 (decimal).
82-
*/
77+
* the most secure supported mode will be automatically selected
78+
*
79+
* param ssid: Pointer to the SSID string.
80+
* param passphrase: Passphrase. Valid characters in a passphrase
81+
* must be between ASCII 32-126 (decimal).
82+
*/
8383
int begin(const char* ssid, const char* passphrase, wl_enc_type security = ENC_TYPE_UNKNOWN);
84-
84+
8585
// Inherit config methods from the parent class
8686
using MbedSocketClass::config;
8787

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

9292
/*
93-
* Disconnect from the network
94-
*
95-
* return: one value of wl_status_t enum
96-
*/
93+
* Disconnect from the network
94+
*
95+
* return: one value of wl_status_t enum
96+
*/
9797
int disconnect(void);
9898

9999
void end(void);
100100

101101
/*
102-
* Return the current SSID associated with the network
103-
*
104-
* return: ssid string
105-
*/
102+
* Return the current SSID associated with the network
103+
*
104+
* return: ssid string
105+
*/
106106
char* SSID();
107107

108108
/*
109-
* Return the current BSSID associated with the network.
110-
* It is the MAC address of the Access Point
111-
*
112-
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
113-
*/
109+
* Return the current BSSID associated with the network.
110+
* It is the MAC address of the Access Point
111+
*
112+
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
113+
*/
114114
uint8_t* BSSID(uint8_t* bssid);
115115

116116
/*
117-
* Return the current RSSI /Received Signal Strength in dBm)
118-
* associated with the network
119-
*
120-
* return: signed value
121-
*/
117+
* Return the current RSSI /Received Signal Strength in dBm)
118+
* associated with the network
119+
*
120+
* return: signed value
121+
*/
122122
int32_t RSSI();
123123

124124
/*
125-
* Return the Encryption Type associated with the network
126-
*
127-
* return: one value of wl_enc_type enum
128-
*/
125+
* Return the Encryption Type associated with the network
126+
*
127+
* return: one value of wl_enc_type enum
128+
*/
129129
uint8_t encryptionType();
130130

131131
/*
132-
* Start scan WiFi networks available
133-
*
134-
* return: Number of discovered networks
135-
*/
132+
* Start scan WiFi networks available
133+
*
134+
* return: Number of discovered networks
135+
*/
136136
int8_t scanNetworks();
137137

138138
/*
139-
* Return the SSID discovered during the network scan.
140-
*
141-
* param networkItem: specify from which network item want to get the information
142-
*
143-
* return: ssid string of the specified item on the networks scanned list
144-
*/
139+
* Return the SSID discovered during the network scan.
140+
*
141+
* param networkItem: specify from which network item want to get the information
142+
*
143+
* return: ssid string of the specified item on the networks scanned list
144+
*/
145145
char* SSID(uint8_t networkItem);
146146

147147
/*
148-
* Return the encryption type of the networks discovered during the scanNetworks
149-
*
150-
* param networkItem: specify from which network item want to get the information
151-
*
152-
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
153-
*/
148+
* Return the encryption type of the networks discovered during the scanNetworks
149+
*
150+
* param networkItem: specify from which network item want to get the information
151+
*
152+
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
153+
*/
154154
uint8_t encryptionType(uint8_t networkItem);
155155

156156
uint8_t* BSSID(uint8_t networkItem, uint8_t* bssid);
157157
uint8_t channel(uint8_t networkItem);
158158

159159
/*
160-
* Return the RSSI of the networks discovered during the scanNetworks
161-
*
162-
* param networkItem: specify from which network item want to get the information
163-
*
164-
* return: signed value of RSSI of the specified item on the networks scanned list
165-
*/
160+
* Return the RSSI of the networks discovered during the scanNetworks
161+
*
162+
* param networkItem: specify from which network item want to get the information
163+
*
164+
* return: signed value of RSSI of the specified item on the networks scanned list
165+
*/
166166
int32_t RSSI(uint8_t networkItem);
167167

168168
/*
169-
* Return Connection status.
170-
*
171-
* return: one of the value defined in wl_status_t
172-
*/
169+
* Return Connection status.
170+
*
171+
* return: one of the value defined in wl_status_t
172+
*/
173173
uint8_t status();
174174

175175
unsigned long getTime();

0 commit comments

Comments
 (0)