added a tidbit of subtle, but important information

diff --git a/ldns/dname.h b/ldns/dname.h
index 9f4227affa8c3147f4895f3b9c87d2eb816d19e2..85ab587160d17d6709bfec2fadd7a7535e16439b 100644 (file)
--- a/ldns/dname.h
+++ b/ldns/dname.h
@@ -115,7 +115,8 @@ void ldns_dname2canonical(const ldns_rdf *rdf);
 
 /**
  * test wether the name sub falls under parent (i.e. is a subdomain
- * of parent.
+ * of parent). This function will return false if the given dnames are
+ * equal.
  * \param[in] sub the name to test
  * \param[in] parent the parent's name
  * \return true if sub falls under parent, otherwise false