diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-09-04 14:03:38 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-09-04 14:23:19 -0400 |
| commit | b3c28677159c26070f26909b3f4c2e00e50d7bff (patch) | |
| tree | 7fe54d69a8ed83927873b1b8fcd595ec81de54ea | |
| parent | 3db56aeeb8a59629690a05cd43565764a254d1e1 (diff) | |
| download | tor-b3c28677159c26070f26909b3f4c2e00e50d7bff.tar.gz tor-b3c28677159c26070f26909b3f4c2e00e50d7bff.zip | |
Document fields of struct_magic_decl_t.
| -rw-r--r-- | src/lib/conf/conftypes.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index fabad97d0c..3db115204b 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -100,8 +100,12 @@ typedef struct struct_member_t { * that they have the correct type. */ typedef struct struct_magic_decl_t { + /** The name of the structure */ const char *typename; + /** A value used to recognize instances of this structure. */ uint32_t magic_val; + /** The location within the structure at which we expect to find + * <b>magic_val</b>. */ int magic_offset; } struct_magic_decl_t; |