diff options
author | Nick Mathewson <nickm@torproject.org> | 2010-10-07 17:10:06 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2010-10-07 17:10:06 -0400 |
commit | c9dece14ae7d9c14c17df6685f7504c23eb65899 (patch) | |
tree | a03b93f4b91c6b50a7b8084f039d7b1179bb4afa /src/or/or.h | |
parent | 34546e2573d4eea02f3622d3d8d27ef0b545974d (diff) | |
download | tor-c9dece14ae7d9c14c17df6685f7504c23eb65899.tar tor-c9dece14ae7d9c14c17df6685f7504c23eb65899.tar.gz |
Add some missing documentation for things added in nodes branch
Diffstat (limited to 'src/or/or.h')
-rw-r--r-- | src/or/or.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/src/or/or.h b/src/or/or.h index c8616beba..96d0d79e1 100644 --- a/src/or/or.h +++ b/src/or/or.h @@ -1648,15 +1648,22 @@ typedef struct routerstatus_t { } routerstatus_t; -/** DOCDOC */ +/** A single entry in a parsed policy summary, describing a range of ports. */ typedef struct short_policy_entry_t { uint16_t min_port, max_port; } short_policy_entry_t; -/** DOCDOC */ +/** A short_poliy_t is the parsed version of a policy summary. */ typedef struct short_policy_t { + /** True if the members of 'entries' are port ranges to accept; false if + * they are port ranges to reject */ unsigned int is_accept : 1; + /** The actual number of values in 'entries'. */ unsigned int n_entries : 31; + /** An array of (probably more than 1!) short_policy_entry_t values, + * each descriping a range of ports that this policy accepts or rejects + * (depending on the value of is_accept). + */ short_policy_entry_t entries[1]; } short_policy_t; |