From e1128d905c7eae33d099e4287823fbd18f3c876e Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Mon, 18 Mar 2013 15:00:52 -0400
Subject: Fix a couple of documentation issues.

---
 src/or/routerparse.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'src/or/routerparse.c')

diff --git a/src/or/routerparse.c b/src/or/routerparse.c
index 63f8fab10..87dc608e5 100644
--- a/src/or/routerparse.c
+++ b/src/or/routerparse.c
@@ -683,7 +683,12 @@ router_get_extrainfo_hash(const char *s, size_t s_len, char *digest)
                               "\nrouter-signature",'\n', DIGEST_SHA1);
 }
 
-/** DOCDOC */
+/** Helper: used to generate signatures for routers, directories and
+ * network-status objects.  Given a <b>digest_len</b>-byte digest in
+ * <b>digest</b> and a secret <b>private_key</b>, generate an PKCS1-padded
+ * signature, BASE64-encode it, surround it with -----BEGIN/END----- pairs,
+ * and return the new signature on success or NULL on failure.
+ */
 char *
 router_get_dirobj_signature(const char *digest,
                             size_t digest_len,
-- 
cgit v1.2.3