chiark / gitweb /
Fix typo in changelog entry for 1.6.1
[adns.git] / src / adns.h
index 899a7319f0c13e19ac50bf883987c2f567f9fc2c..ba44b06c972add406a5c565d6aae008f1c1bb244 100644 (file)
@@ -1085,8 +1085,13 @@ const char *adns_errtypeabbrev(adns_status st);
  * the abbreviation of the error - eg, for adns_s_timeout it returns
  * "timeout".  adns_errtypeabbrev returns the abbreviation of the
  * error class: ie, for values up to adns_s_max_XXX it will return the
- * string XXX.  You MUST NOT call these functions with status values
- * not returned by the same adns library.
+ * string XXX.
+ *
+ * If you call these functions with status values not actually
+ * returned from other functions in the same adns library, the
+ * returned information may be NULL.  (You are also guaranteed
+ * that the return value will not be NULL for values in the
+ * adns_status enum, *except* for adns_s_max_XXXX.)
  */
 
 #ifdef __cplusplus