Skip to content

Commit 53fc01b

Browse files
committed
SocketHelpers: align comments
1 parent 33325ea commit 53fc01b

File tree

1 file changed

+57
-57
lines changed

1 file changed

+57
-57
lines changed

Diff for: libraries/SocketWrapper/src/SocketHelpers.h

+57-57
Original file line numberDiff line numberDiff line change
@@ -28,100 +28,100 @@ class MbedSocketClass {
2828
void config(IPAddress local_ip);
2929

3030
/* Change Ip configuration settings disabling the dhcp client
31-
*
32-
* param local_ip: Static ip configuration as string
33-
*/
31+
*
32+
* param local_ip: Static ip configuration as string
33+
*/
3434
void config(const char* local_ip);
3535

3636
/* Change Ip configuration settings disabling the dhcp client
37-
*
38-
* param local_ip: Static ip configuration
39-
* param dns_server: IP configuration for DNS server 1
40-
*/
37+
*
38+
* param local_ip: Static ip configuration
39+
* param dns_server: IP configuration for DNS server 1
40+
*/
4141
void config(IPAddress local_ip, IPAddress dns_server);
4242

4343
/* Change Ip configuration settings disabling the dhcp client
44-
*
45-
* param local_ip: Static ip configuration
46-
* param dns_server: IP configuration for DNS server 1
47-
* param gateway : Static gateway configuration
48-
*/
44+
*
45+
* param local_ip: Static ip configuration
46+
* param dns_server: IP configuration for DNS server 1
47+
* param gateway : Static gateway configuration
48+
*/
4949
void config(IPAddress local_ip, IPAddress dns_server, IPAddress gateway);
5050

5151
/* Change Ip configuration settings disabling the dhcp client
52-
*
53-
* param local_ip: Static ip configuration
54-
* param dns_server: IP configuration for DNS server 1
55-
* param gateway: Static gateway configuration
56-
* param subnet: Static Subnet mask
57-
*/
52+
*
53+
* param local_ip: Static ip configuration
54+
* param dns_server: IP configuration for DNS server 1
55+
* param gateway: Static gateway configuration
56+
* param subnet: Static Subnet mask
57+
*/
5858
void config(IPAddress local_ip, IPAddress dns_server, IPAddress gateway, IPAddress subnet);
5959

6060
/* Change DNS Ip configuration
61-
*
62-
* param dns_server1: ip configuration for DNS server 1
63-
*/
61+
*
62+
* param dns_server1: ip configuration for DNS server 1
63+
*/
6464
void setDNS(IPAddress dns_server1);
6565

6666
/* Change DNS Ip configuration
67-
*
68-
* param dns_server1: ip configuration for DNS server 1
69-
* param dns_server2: ip configuration for DNS server 2
70-
*
71-
*/
67+
*
68+
* param dns_server1: ip configuration for DNS server 1
69+
* param dns_server2: ip configuration for DNS server 2
70+
*
71+
*/
7272
void setDNS(IPAddress dns_server1, IPAddress dns_server2);
7373

7474
/*
75-
* Get the interface IP address.
76-
*
77-
* return: Ip address value
78-
*/
75+
* Get the interface IP address.
76+
*
77+
* return: Ip address value
78+
*/
7979
IPAddress localIP();
8080

8181
/*
82-
* Get the interface subnet mask address.
83-
*
84-
* return: subnet mask address value
85-
*/
82+
* Get the interface subnet mask address.
83+
*
84+
* return: subnet mask address value
85+
*/
8686
IPAddress subnetMask();
8787

8888
/*
89-
* Get the gateway ip address.
90-
*
91-
* return: gateway ip address value
92-
*/
89+
* Get the gateway ip address.
90+
*
91+
* return: gateway ip address value
92+
*/
9393
IPAddress gatewayIP();
9494

9595
/*
96-
* Get the DNS Server ip address.
97-
*
98-
* return: DNS Server ip address value
99-
*/
96+
* Get the DNS Server ip address.
97+
*
98+
* return: DNS Server ip address value
99+
*/
100100
IPAddress dnsServerIP();
101101

102102
/*
103-
* Get the DNS Server ip address.
104-
*
105-
* return: DNS Server ip address value
106-
*/
103+
* Get the DNS Server ip address.
104+
*
105+
* return: DNS Server ip address value
106+
*/
107107
IPAddress dnsIP(int n = 0);
108108

109109
virtual NetworkInterface* getNetwork() = 0;
110-
110+
111111
/*
112-
* Download a file from an HTTP endpoint and save it in the provided `target` location on the fs
113-
* The parameter cbk can be used to perform actions on the buffer before saving on the fs
114-
*
115-
* return: on success the size of the downloaded file, on error -status code
116-
*/
112+
* Download a file from an HTTP endpoint and save it in the provided `target` location on the fs
113+
* The parameter cbk can be used to perform actions on the buffer before saving on the fs
114+
*
115+
* return: on success the size of the downloaded file, on error -status code
116+
*/
117117
int download(
118118
const char* url, const char* target, bool const is_https = false);
119119
/*
120-
* Download a file from an HTTP endpoint and handle the body of the request on a callback
121-
* passed as an argument
122-
*
123-
* return: on success the size of the downloaded file, on error -status code
124-
*/
120+
* Download a file from an HTTP endpoint and handle the body of the request on a callback
121+
* passed as an argument
122+
*
123+
* return: on success the size of the downloaded file, on error -status code
124+
*/
125125
int download(
126126
const char* url, bool const is_https = false,
127127
mbed::Callback<void(const char*, uint32_t)> cbk = nullptr);

0 commit comments

Comments
 (0)