[Asterisk-code-review] DNS: Fix doxygen comments. (asterisk[master])

[Mark Michelson]

Mark Michelson has submitted this change and it was merged.

Change subject: DNS: Fix doxygen comments.
......................................................................


DNS: Fix doxygen comments.

Change-Id: Icafea3fb4ea64ac027561b23cbfe2b17997dc549
---
M include/asterisk/dns_internal.h
M main/dns_query_set.c
2 files changed, 10 insertions(+), 2 deletions(-)

Approvals:
  Mark Michelson: Looks good to me, approved; Verified



diff --git a/include/asterisk/dns_internal.h b/include/asterisk/dns_internal.h
index be8794b..d517748 100644
--- a/include/asterisk/dns_internal.h
+++ b/include/asterisk/dns_internal.h
@@ -161,7 +161,7 @@
 struct dns_query_set_query {
 	/*! \brief Whether the query started successfully or not */
 	unsigned int started;
-	/*! \brief THe query itself */
+	/*! \brief The query itself */
 	struct ast_dns_query *query;
 };
 
@@ -169,7 +169,7 @@
 struct ast_dns_query_set {
 	/*! \brief DNS queries */
 	AST_VECTOR(, struct dns_query_set_query) queries;
-	/* \brief Whether the query set is in progress or not */
+	/*! \brief Whether the query set is in progress or not */
 	int in_progress;
 	/*! \brief The total number of completed queries */
 	int queries_completed;
diff --git a/main/dns_query_set.c b/main/dns_query_set.c
index 8dfc5ea..147c737 100644
--- a/main/dns_query_set.c
+++ b/main/dns_query_set.c
@@ -117,6 +117,14 @@
 		return -1;
 	}
 
+	/*
+	 * We are intentionally passing NULL for the user data even
+	 * though dns_query_set_callback() is not NULL tolerant.  Doing
+	 * this avoids a circular reference chain until the queries are
+	 * started.  ast_dns_query_set_resolve_async() will set the
+	 * query user_data for us later when we actually kick off the
+	 * queries.
+	 */
 	query.query = dns_query_alloc(name, rr_type, rr_class, dns_query_set_callback, NULL);
 	if (!query.query) {
 		return -1;

-- 
To view, visit https://gerrit.asterisk.org/624
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Icafea3fb4ea64ac027561b23cbfe2b17997dc549
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Owner: Richard Mudgett <rmudgett at digium.com>
Gerrit-Reviewer: Mark Michelson <mmichelson at digium.com>