diff options
author | Nick Mathewson <nickm@torproject.org> | 2019-03-12 18:53:24 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2019-03-25 16:35:34 -0400 |
commit | 3d6bf7b36e419bbabd48b4bed82f12fca1a922b3 (patch) | |
tree | 66b1c9364a31f7e03174d2781590d2591535f78d /src/lib/pubsub/pubsub_macros.h | |
parent | b4f28b9df8188af82a0140b1831ee4b50c6e4f6d (diff) | |
download | tor-3d6bf7b36e419bbabd48b4bed82f12fca1a922b3.tar.gz tor-3d6bf7b36e419bbabd48b4bed82f12fca1a922b3.zip |
Document several issues found by Taylor
Diffstat (limited to 'src/lib/pubsub/pubsub_macros.h')
-rw-r--r-- | src/lib/pubsub/pubsub_macros.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/lib/pubsub/pubsub_macros.h b/src/lib/pubsub/pubsub_macros.h index aed9c51282..4d0638d1df 100644 --- a/src/lib/pubsub/pubsub_macros.h +++ b/src/lib/pubsub/pubsub_macros.h @@ -175,7 +175,8 @@ * Use this macro in a header to declare the existence of a given message, * taking a pointer as auxiliary data. * - * "messagename" is a unique identifier for the message. + * "messagename" is a unique identifier for the message; it must be a valid + * C identifier. * * "typename" is a unique identifier for the type of the auxiliary data. * @@ -199,7 +200,8 @@ * Use this macro in a header to declare the existence of a given message, * taking an integer as auxiliary data. * - * "messagename" is a unique identifier for the message. + * "messagename" is a unique identifier for the message; it must be a valid + * C identifier. * * "typename" is a unique identifier for the type of the auxiliary data. * |