[or-cvs] [tor/master] clarify fmt_addr32 documentation to note that the address is in host-order

[nickm at torproject.org]

Author: Nick Mathewson <nickm at torproject.org>
Date: Fri, 15 Oct 2010 18:04:07 -0400
Subject: clarify fmt_addr32 documentation to note that the address is in host-order
Commit: 4dbd8ba008de7eea623e3b760a6c43040d145a8d

---
 src/common/address.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/common/address.c b/src/common/address.c
index 323e0ee..a3f12ac 100644
--- a/src/common/address.c
+++ b/src/common/address.c
@@ -925,8 +925,9 @@ fmt_addr(const tor_addr_t *addr)
   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 *
 fmt_addr32(uint32_t addr)
 {
-- 
1.7.1