diff options
author | Nick Mathewson <nickm@torproject.org> | 2019-11-16 15:12:35 -0500 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2019-11-16 15:12:35 -0500 |
commit | 5a1a60e65eb6904f383d18fae271684b4264acd9 (patch) | |
tree | 9fe98f52ef797036754cde7ebd37ab7c5e1ac9ac /src/lib/container | |
parent | c9b2fe0460c417278c856db3ee6388f7e3277719 (diff) | |
download | tor-5a1a60e65eb6904f383d18fae271684b4264acd9.tar.gz tor-5a1a60e65eb6904f383d18fae271684b4264acd9.zip |
Revise struct names in examples in comments to end with _t
Diffstat (limited to 'src/lib/container')
-rw-r--r-- | src/lib/container/handles.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/lib/container/handles.h b/src/lib/container/handles.h index ca7c94559e..b6dcadb6be 100644 --- a/src/lib/container/handles.h +++ b/src/lib/container/handles.h @@ -16,33 +16,33 @@ * To enable a type to have handles, add a HANDLE_ENTRY() field in its * definition, as in: * - * struct walrus { - * HANDLE_ENTRY(wlr, walrus); + * struct walrus_t { + * HANDLE_ENTRY(wlr, walrus_t); * // ... * }; * - * And invoke HANDLE_DECL(wlr, walrus, [static]) to declare the handle + * And invoke HANDLE_DECL(wlr, walrus_t, [static]) to declare the handle * manipulation functions (typically in a header): * * // opaque handle to walrus. * typedef struct wlr_handle_t wlr_handle_t; * * // make a new handle - * struct wlr_handle_t *wlr_handle_new(struct walrus *); + * struct wlr_handle_t *wlr_handle_new(struct walrus_t *); * * // release a handle * void wlr_handle_free(wlr_handle_t *); * * // return the pointed-to walrus, or NULL. - * struct walrus *wlr_handle_get(wlr_handle_t *). + * struct walrus_t *wlr_handle_get(wlr_handle_t *). * * // call this function when you're about to free the walrus; * // it invalidates all handles. (IF YOU DON'T, YOU WILL HAVE * // DANGLING REFERENCES) - * void wlr_handles_clear(struct walrus *); + * void wlr_handles_clear(struct walrus_t *); * * Finally, use HANDLE_IMPL() to define the above functions in some - * appropriate C file: HANDLE_IMPL(wlr, walrus, [static]) + * appropriate C file: HANDLE_IMPL(wlr, walrus_t, [static]) * **/ |