Skip to content

Commit 2f2cb1e

Browse files
paul-szczepanek-armCruz Monrreal II
authored andcommitted
incorrect doc was copy pasted
replaced with copydoc instead
1 parent 43c489e commit 2f2cb1e

File tree

2 files changed

+16
-40
lines changed

2 files changed

+16
-40
lines changed

components/wifi/esp8266-driver/ESP8266Interface.h

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -153,36 +153,12 @@ class ESP8266Interface : public NetworkStack, public WiFiInterface
153153
*/
154154
using NetworkInterface::add_dns_server;
155155

156-
/** Set socket options
157-
*
158-
* The setsockopt allow an application to pass stack-specific hints
159-
* to the underlying stack. For unsupported options,
160-
* NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
161-
*
162-
* @param handle Socket handle
163-
* @param level Stack-specific protocol level
164-
* @param optname Stack-specific option identifier
165-
* @param optval Option value
166-
* @param optlen Length of the option value
167-
* @return 0 on success, negative error code on failure
156+
/** @copydoc NetworkStack::setsockopt
168157
*/
169158
virtual nsapi_error_t setsockopt(nsapi_socket_t handle, int level,
170159
int optname, const void *optval, unsigned optlen);
171160

172-
/** Get socket options
173-
*
174-
* getsockopt allows an application to retrieve stack-specific options
175-
* from the underlying stack using stack-specific level and option names,
176-
* or to request generic options using levels from nsapi_socket_level_t.
177-
*
178-
* For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned
179-
* and the socket is unmodified.
180-
*
181-
* @param level Stack-specific protocol level or nsapi_socket_level_t
182-
* @param optname Level-specific option name
183-
* @param optval Destination for option value
184-
* @param optlen Length of the option value
185-
* @return 0 on success, negative error code on failure
161+
/** @copydoc NetworkStack::getsockopt
186162
*/
187163
virtual nsapi_error_t getsockopt(nsapi_socket_t handle, int level, int optname,
188164
void *optval, unsigned *optlen);

features/netsocket/NetworkStack.h

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -336,34 +336,34 @@ class NetworkStack: public DNS {
336336
*/
337337
virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data) = 0;
338338

339-
/** Set stack-specific socket options
339+
/** Set stack-specific socket options.
340340
*
341341
* The setsockopt allow an application to pass stack-specific hints
342342
* to the underlying stack. For unsupported options,
343343
* NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
344344
*
345-
* @param handle Socket handle
346-
* @param level Stack-specific protocol level
347-
* @param optname Stack-specific option identifier
348-
* @param optval Option value
349-
* @param optlen Length of the option value
350-
* @return NSAPI_ERROR_OK on success, negative error code on failure
345+
* @param handle Socket handle.
346+
* @param level Stack-specific protocol level.
347+
* @param optname Stack-specific option identifier.
348+
* @param optval Option value.
349+
* @param optlen Length of the option value.
350+
* @return NSAPI_ERROR_OK on success, negative error code on failure.
351351
*/
352352
virtual nsapi_error_t setsockopt(nsapi_socket_t handle, int level,
353353
int optname, const void *optval, unsigned optlen);
354354

355-
/** Get stack-specific socket options
355+
/** Get stack-specific socket options.
356356
*
357357
* The getstackopt allow an application to retrieve stack-specific hints
358358
* from the underlying stack. For unsupported options,
359359
* NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified.
360360
*
361-
* @param handle Socket handle
362-
* @param level Stack-specific protocol level
363-
* @param optname Stack-specific option identifier
364-
* @param optval Destination for option value
365-
* @param optlen Length of the option value
366-
* @return NSAPI_ERROR_OK on success, negative error code on failure
361+
* @param handle Socket handle.
362+
* @param level Stack-specific protocol level.
363+
* @param optname Stack-specific option identifier.
364+
* @param optval Destination for option value.
365+
* @param optlen Length of the option value.
366+
* @return NSAPI_ERROR_OK on success, negative error code on failure.
367367
*/
368368
virtual nsapi_error_t getsockopt(nsapi_socket_t handle, int level,
369369
int optname, void *optval, unsigned *optlen);

0 commit comments

Comments
 (0)