From 10b4b5d200f8ad703206588220b59f4fbbc20387 Mon Sep 17 00:00:00 2001
From: Corey Farrell <git@cfware.com>
Date: Sun, 19 Nov 2017 22:23:44 -0500
Subject: [PATCH] loader: Fix comments in struct ast_module.
Make the comments follow doxygen format, move comments to the line
before each field they describe.
Change-Id: Ic445468398b5e88f13910f7c2f70bd15aad33a27
---
main/loader.c | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/main/loader.c b/main/loader.c
index add6a42097..2238975148 100644
--- a/main/loader.c
+++ b/main/loader.c
@@ -117,14 +117,20 @@ static int modules_loaded;
struct ast_module {
const struct ast_module_info *info;
- /* Used to get module references into refs log */
+ /*! Used to get module references into refs log */
void *ref_debug;
- void *lib; /* the shared lib, or NULL if embedded */
- int usecount; /* the number of 'users' currently in this module */
- struct module_user_list users; /* the list of users in the module */
+ /*! The shared lib. */
+ void *lib;
+ /*! Number of 'users' and other references currently holding the module. */
+ int usecount;
+ /*! List of users holding the module. */
+ struct module_user_list users;
struct {
+ /*! The module running and ready to accept requests. */
unsigned int running:1;
+ /*! The module has declined to start. */
unsigned int declined:1;
+ /*! This module is being held open until it's time to shutdown. */
unsigned int keepuntilshutdown:1;
} flags;
AST_LIST_ENTRY(ast_module) list_entry;
--
GitLab