[tor-commits] [tor/master] Document fields of struct_magic_decl_t.

[asn at torproject.org]

commit b3c28677159c26070f26909b3f4c2e00e50d7bff
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Sep 4 14:03:38 2019 -0400

    Document fields of struct_magic_decl_t.
---
 src/lib/conf/conftypes.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h
index fabad97d0..3db115204 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;