Browse Source

clarify fmt_addr32 documentation to note that the address is in host-order

Nick Mathewson 15 years ago
parent
commit
4dbd8ba008
1 changed files with 3 additions and 2 deletions
  1. 3 2
      src/common/address.c

+ 3 - 2
src/common/address.c

@@ -925,8 +925,9 @@ fmt_addr(const tor_addr_t *addr)
   return buf;
   return buf;
 }
 }
 
 
-/** Like fmt_addr(), but for IPv4 addresses. Also not thread-safe, also
- * clobbers its return buffer on repeated calls. */
+/** Like fmt_addr(), but takes <b>addr</b> as a host-order IPv4
+ * addresses. Also not thread-safe, also clobbers its return buffer on
+ * repeated calls. */
 const char *
 const char *
 fmt_addr32(uint32_t addr)
 fmt_addr32(uint32_t addr)
 {
 {