mgcp-client: pool: Improve documentation of some internal fields
Change-Id: Ic9823ab0a3f101549452a7c7a0b1b5b21aaa837c
diff --git a/include/osmocom/mgcp_client/mgcp_client_pool_internal.h b/include/osmocom/mgcp_client/mgcp_client_pool_internal.h
index 95f5525..588ba04 100644
--- a/include/osmocom/mgcp_client/mgcp_client_pool_internal.h
+++ b/include/osmocom/mgcp_client/mgcp_client_pool_internal.h
@@ -2,6 +2,7 @@
/* Struct to handle a member of a pool of MGWs. */
struct mgcp_client_pool_member {
+ /* Entry in llist mgcp_client_pool->pool. */
struct llist_head list;
/* Reference number assinged by VTY. This number is used to manage the pool from the VTY and to identify it in
@@ -31,7 +32,7 @@
* mgcp_client_vty_init() and actively registered by the API user using mgcp_client_pool_register_single() */
struct mgcp_client *mgcp_client_single;
- /* A list that manages the pool members (see above) */
+ /* A list that manages the pool members (see mgcp_client_pool_member->list above) */
struct llist_head pool;
/* String to use for indentation when writing the configuration file to the VTY. This field is populated by