summaryrefslogtreecommitdiffstats
path: root/src/lib/dns/labelsequence.h
diff options
context:
space:
mode:
authorMukund Sivaraman <muks@isc.org>2012-07-05 07:40:22 +0200
committerMukund Sivaraman <muks@isc.org>2012-07-05 07:40:22 +0200
commit9771dfb067dc0bf250d69bc4c07c811573d2c656 (patch)
treeacd7cd4436a42fe90bf8a5c66efba5709040b2b6 /src/lib/dns/labelsequence.h
parent[2053] Use getDataLength() to find out the right end to stop (diff)
downloadkea-9771dfb067dc0bf250d69bc4c07c811573d2c656.tar.xz
kea-9771dfb067dc0bf250d69bc4c07c811573d2c656.zip
[2053] Add comment that toText(bool) variant is a helper for Name::toText()
Diffstat (limited to 'src/lib/dns/labelsequence.h')
-rw-r--r--src/lib/dns/labelsequence.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/lib/dns/labelsequence.h b/src/lib/dns/labelsequence.h
index 7d8827e00f..d2d9d08cae 100644
--- 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;