Document the new directory_request_t API and add some assertions

1 files changed, 6 insertions, 0 deletions

diff --git a/src/or/directory.h b/src/or/directory.h
index 7399b706ad..6b2f50b45d 100644
--- a/src/or/directory.h
+++ b/src/or/directory.h
@@ -41,6 +41,12 @@ typedef enum {
 
 int directory_must_use_begindir(const or_options_t *options);
 
+/**
+ * A directory_request_t describes the information about a directory request
+ * at the client side.  It describes what we're going to ask for, which
+ * directory we're going to ask for it, how we're going to contact that
+ * directory, and (in some cases) what to do with it when we're done.
+ */
 typedef struct directory_request_t directory_request_t;
 directory_request_t *directory_request_new(uint8_t dir_purpose);
 void directory_request_free(directory_request_t *req);