code review #7: Fix comment for is_glue in ldns_dnssec_name struct.

diff --git a/ldns/dnssec_zone.h b/ldns/dnssec_zone.h
index 7751b419bec8afb0a3f521c8f99a7b7ed9f17edc..4b0273eb2a955f97cd8d1b7f3ba902948f32b840 100644 (file)
--- a/ldns/dnssec_zone.h
+++ b/ldns/dnssec_zone.h
@@ -70,14 +70,13 @@ struct ldns_struct_dnssec_name
         */
        ldns_dnssec_rrs *nsec_signatures;
        /**
-        * Set to true if this name contains only glue rrsets.
-        * Names that contain other obscured rrsets and records with glue on the
-        * delegation point will NOT have this bool set to true.
-        * ldns_dnssec_zone_mark_glue() should have been called before using this
-        * field.
-        * This field should not be read directly, but only via the 
-        * ldns_dnssec_name_is_glue() function.
-        * 
+        * Unlike what the name is_glue suggests, this field is set to true by
+        * ldns_dnssec_zone_mark_glue() or ldns_dnssec_zone_mark_and_get_glue()
+        * when the name, this dnssec_name struct represents, is occluded.
+        * Names that contain other obscured rrsets and records with glue on
+        * the delegation point will NOT have this bool set to true.
+        * This field should NOT be read directly, but only via the 
+        * ldns_dnssec_name_is_glue() function!
         */
        bool is_glue;
        /**