diff options
| author | Nick Mathewson <nickm@torproject.org> | 2007-07-30 17:46:12 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2007-07-30 17:46:12 +0000 |
| commit | 23a345b3c2e7877d3cc4821ec1764f885fa01b2f (patch) | |
| tree | 1a12c101ea5f44ed7712aeb6f148186eef23850e /src/common/compat.c | |
| parent | ec1d599302891047d2bd2f722085e187661610f6 (diff) | |
| download | tor-23a345b3c2e7877d3cc4821ec1764f885fa01b2f.tar.gz tor-23a345b3c2e7877d3cc4821ec1764f885fa01b2f.zip | |
r14015@catbus: nickm | 2007-07-30 13:18:05 -0400
Add missing code documentation in src/common
svn:r10991
Diffstat (limited to 'src/common/compat.c')
| -rw-r--r-- | src/common/compat.c | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/common/compat.c b/src/common/compat.c index eee9b87b09..710854b1f3 100644 --- a/src/common/compat.c +++ b/src/common/compat.c @@ -1023,9 +1023,12 @@ tor_lookup_hostname(const char *name, uint32_t *addr) } /** Similar behavior to Unix gethostbyname: resolve <b>name</b>, and set - * *<b>addr</b> to the proper IP address and family. + * *<b>addr</b> to the proper IP address and family. The <b>family</b> + * argument (which must be AF_INET, AF_INET6, or AF_UNSPEC) declares a + * <i>preferred</i> family, though another one may be returned if only one + * family is implemented for this address. + * * Return 0 on success, -1 on failure; 1 on transient failure. - * DOCDOC family argument. */ int tor_addr_lookup(const char *name, uint16_t family, tor_addr_t *addr) |