[2053] Add comment that toText(bool) variant is a helper for Name::toText()

diff --git a/src/lib/dns/labelsequence.h b/src/lib/dns/labelsequence.h
index 7d8827e00fd5be682eec4046beeba0639baf619c..d2d9d08cae111546c79b6a256b8931a5983fc122 100644 (file)
--- a/src/lib/dns/labelsequence.h
+++ b/src/lib/dns/labelsequence.h
@@ -150,6 +150,9 @@ private:
     /// returned string ends with a dot '.' if
     /// <code>omit_final_dot</code> is <code>false</code>.
     ///
+    /// This method is used as a helper for <code>Name::toText()</code>
+    /// only.
+    ///
     /// \param omit_final_dot whether to omit the trailing dot in the output.
     /// \return a string representation of the <code>LabelSequence</code>.
     std::string toText(bool omit_final_dot) const;