diff options
| author | Damien George <damien.p.george@gmail.com> | 2014-10-31 01:11:55 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-10-31 01:12:54 +0000 |
| commit | 1a8573ed0ed72825a5cedc6a07277535aa2630fa (patch) | |
| tree | 91231aea68479ed35266884ff9b413c4419190e3 /stmhal/modusocket.c | |
| parent | 47f349e7dea25fd7b2dd9d387654418aeb7de0bd (diff) | |
stmhal: Update some inlined docs for network and CAN.
Diffstat (limited to 'stmhal/modusocket.c')
| -rw-r--r-- | stmhal/modusocket.c | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/stmhal/modusocket.c b/stmhal/modusocket.c index 6a544cb3e..bab108703 100644 --- a/stmhal/modusocket.c +++ b/stmhal/modusocket.c @@ -41,9 +41,11 @@ #include "runtime.h" #include "modnetwork.h" -/// \module usocket +/// \module usocket - socket module +/// +/// Socket functionality. -/// \method socket(family=AF_INET, type=SOCK_STREAM, fileno=-1) +/// \function socket(family=AF_INET, type=SOCK_STREAM, fileno=-1) /// Create a socket. STATIC mp_obj_t mod_usocket_socket(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { static const mp_arg_t allowed_args[] = { @@ -75,7 +77,7 @@ STATIC mp_obj_t mod_usocket_socket(mp_uint_t n_args, const mp_obj_t *pos_args, m } STATIC MP_DEFINE_CONST_FUN_OBJ_KW(mod_usocket_socket_obj, 0, mod_usocket_socket); -/// \method getaddrinfo(host, port) +/// \function getaddrinfo(host, port) STATIC mp_obj_t mod_usocket_getaddrinfo(mp_obj_t host_in, mp_obj_t port_in) { mp_uint_t hlen; const char *host = mp_obj_str_get_data(host_in, &hlen); |