| Message ID | 20231206004024.249222-1-gerickson@nuovations.com (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
| Series | None | expand |
diff --git a/src/connman.h b/src/connman.h index e0736e41ad68..6b86be6f5ab3 100644 --- a/src/connman.h +++ b/src/connman.h @@ -19,6 +19,13 @@ * */ +/** + * @file + * This file defines internal, non-public (that is, neither visible + * nor consumable by plugins), cross-module interfaces. + * + */ + #include <stdbool.h> #include <glib.h>
From: Grant Erickson <erick205@umn.edu> While there is a very specific organization to the project headers and symbols, it is not immediately evident at first glance to the uninitiated. The addition of this file comment helps inform the uninitiated that 'connman.h' is reserved for private, cross-project interfaces which differentiates it from those publicly-consumable headers in 'include/'. --- src/connman.h | 7 +++++++ 1 file changed, 7 insertions(+)