diff options
| author | Damien George <damien.p.george@gmail.com> | 2014-10-31 01:37:19 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-10-31 01:37:19 +0000 |
| commit | 88d3054ac072f9c73b0f3f045c59ba74f6730c1d (patch) | |
| tree | 6db7851068908c0640b1ed306d6823871fd3d742 /docs/library/usocket.rst | |
| parent | 7c4445afe104631d5fe8e7401d50f40f205e35b9 (diff) | |
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
Diffstat (limited to 'docs/library/usocket.rst')
| -rw-r--r-- | docs/library/usocket.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/library/usocket.rst b/docs/library/usocket.rst new file mode 100644 index 000000000..271e83da8 --- /dev/null +++ b/docs/library/usocket.rst @@ -0,0 +1,18 @@ +:mod:`usocket` --- socket module +================================ + +.. module:: usocket + :synopsis: socket module + +Socket functionality. + + +Functions +--------- + +.. function:: getaddrinfo(host, port) + + +.. function:: socket(family=AF_INET, type=SOCK_STREAM, fileno=-1) + + Create a socket. |