Skip to content

Commit b6bc4bf

Browse files
committed
WiFi: align comments
1 parent 89d6ea7 commit b6bc4bf

File tree

1 file changed

+59
-59
lines changed

1 file changed

+59
-59
lines changed

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

+59-59
Original file line numberDiff line numberDiff line change
@@ -55,25 +55,25 @@ 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);
7878

7979
// When using DHCP the hostname provided will be used.
@@ -87,86 +87,86 @@ class WiFiClass : public MbedSocketClass {
8787
int beginAP(const char* ssid, const char* passphrase, uint8_t channel = DEFAULT_AP_CHANNEL);
8888

8989
/*
90-
* Disconnect from the network
91-
*
92-
* return: one value of wl_status_t enum
93-
*/
90+
* Disconnect from the network
91+
*
92+
* return: one value of wl_status_t enum
93+
*/
9494
int disconnect(void);
9595

9696
void end(void);
9797

9898
/*
99-
* Return the current SSID associated with the network
100-
*
101-
* return: ssid string
102-
*/
99+
* Return the current SSID associated with the network
100+
*
101+
* return: ssid string
102+
*/
103103
char* SSID();
104104

105105
/*
106-
* Return the current BSSID associated with the network.
107-
* It is the MAC address of the Access Point
108-
*
109-
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
110-
*/
106+
* Return the current BSSID associated with the network.
107+
* It is the MAC address of the Access Point
108+
*
109+
* return: pointer to uint8_t array with length WL_MAC_ADDR_LENGTH
110+
*/
111111
uint8_t* BSSID(uint8_t* bssid);
112112

113113
/*
114-
* Return the current RSSI /Received Signal Strength in dBm)
115-
* associated with the network
116-
*
117-
* return: signed value
118-
*/
114+
* Return the current RSSI /Received Signal Strength in dBm)
115+
* associated with the network
116+
*
117+
* return: signed value
118+
*/
119119
int32_t RSSI();
120120

121121
/*
122-
* Return the Encryption Type associated with the network
123-
*
124-
* return: one value of wl_enc_type enum
125-
*/
122+
* Return the Encryption Type associated with the network
123+
*
124+
* return: one value of wl_enc_type enum
125+
*/
126126
uint8_t encryptionType();
127127

128128
/*
129-
* Start scan WiFi networks available
130-
*
131-
* return: Number of discovered networks
132-
*/
129+
* Start scan WiFi networks available
130+
*
131+
* return: Number of discovered networks
132+
*/
133133
int8_t scanNetworks();
134134

135135
/*
136-
* Return the SSID discovered during the network scan.
137-
*
138-
* param networkItem: specify from which network item want to get the information
139-
*
140-
* return: ssid string of the specified item on the networks scanned list
141-
*/
136+
* Return the SSID discovered during the network scan.
137+
*
138+
* param networkItem: specify from which network item want to get the information
139+
*
140+
* return: ssid string of the specified item on the networks scanned list
141+
*/
142142
char* SSID(uint8_t networkItem);
143143

144144
/*
145-
* Return the encryption type of the networks discovered during the scanNetworks
146-
*
147-
* param networkItem: specify from which network item want to get the information
148-
*
149-
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
150-
*/
145+
* Return the encryption type of the networks discovered during the scanNetworks
146+
*
147+
* param networkItem: specify from which network item want to get the information
148+
*
149+
* return: encryption type (enum wl_enc_type) of the specified item on the networks scanned list
150+
*/
151151
uint8_t encryptionType(uint8_t networkItem);
152152

153153
uint8_t* BSSID(uint8_t networkItem, uint8_t* bssid);
154154
uint8_t channel(uint8_t networkItem);
155155

156156
/*
157-
* Return the RSSI of the networks discovered during the scanNetworks
158-
*
159-
* param networkItem: specify from which network item want to get the information
160-
*
161-
* return: signed value of RSSI of the specified item on the networks scanned list
162-
*/
157+
* Return the RSSI of the networks discovered during the scanNetworks
158+
*
159+
* param networkItem: specify from which network item want to get the information
160+
*
161+
* return: signed value of RSSI of the specified item on the networks scanned list
162+
*/
163163
int32_t RSSI(uint8_t networkItem);
164164

165165
/*
166-
* Return Connection status.
167-
*
168-
* return: one of the value defined in wl_status_t
169-
*/
166+
* Return Connection status.
167+
*
168+
* return: one of the value defined in wl_status_t
169+
*/
170170
uint8_t status();
171171

172172
unsigned long getTime();

0 commit comments

Comments
 (0)