Skip to content

Commit 83b01ac

Browse files
author
Veijo Pesonen
committed
Updates doxygen documentation
1 parent 92ef9e8 commit 83b01ac

File tree

1 file changed

+2
-26
lines changed

1 file changed

+2
-26
lines changed

ESP8266Interface.h

+2-26
Original file line numberDiff line numberDiff line change
@@ -176,36 +176,12 @@ class ESP8266Interface : public NetworkStack, public WiFiInterface {
176176
*/
177177
using NetworkInterface::add_dns_server;
178178

179-
/** Set socket options
180-
*
181-
* The setsockopt allow an application to pass stack-specific hints
182-
* to the underlying stack. For unsupported options,
183-
* NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
184-
*
185-
* @param handle Socket handle
186-
* @param level Stack-specific protocol level
187-
* @param optname Stack-specific option identifier
188-
* @param optval Option value
189-
* @param optlen Length of the option value
190-
* @return 0 on success, negative error code on failure
179+
/** @copydoc NetworkStack::setsockopt
191180
*/
192181
virtual nsapi_error_t setsockopt(nsapi_socket_t handle, int level,
193182
int optname, const void *optval, unsigned optlen);
194183

195-
/** Get socket options
196-
*
197-
* getsockopt allows an application to retrieve stack-specific options
198-
* from the underlying stack using stack-specific level and option names,
199-
* or to request generic options using levels from nsapi_socket_level_t.
200-
*
201-
* For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned
202-
* and the socket is unmodified.
203-
*
204-
* @param level Stack-specific protocol level or nsapi_socket_level_t
205-
* @param optname Level-specific option name
206-
* @param optval Destination for option value
207-
* @param optlen Length of the option value
208-
* @return 0 on success, negative error code on failure
184+
/** @copydoc NetworkStack::getsockopt
209185
*/
210186
virtual nsapi_error_t getsockopt(nsapi_socket_t handle, int level, int optname,
211187
void *optval, unsigned *optlen);

0 commit comments

Comments
 (0)