summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRemko Tronçon <git@el-tramo.be>2011-07-03 17:04:53 (GMT)
committerRemko Tronçon <git@el-tramo.be>2011-07-03 17:04:53 (GMT)
commite4c1ffda13c4f7da7e2e8dd955b859d030134cbc (patch)
tree878155bda9393a88e4f7e29a00117de8d8b6b0d0 /Swiften
parentb25c6f15c62f226c31ad514a973b0920b89b20c5 (diff)
downloadswift-contrib-e4c1ffda13c4f7da7e2e8dd955b859d030134cbc.zip
swift-contrib-e4c1ffda13c4f7da7e2e8dd955b859d030134cbc.tar.bz2
Tweaked JID doxygen.
Diffstat (limited to 'Swiften')
-rw-r--r--Swiften/JID/JID.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/Swiften/JID/JID.h b/Swiften/JID/JID.h
index 8e3b949..876daa0 100644
--- a/Swiften/JID/JID.h
+++ b/Swiften/JID/JID.h
@@ -18,6 +18,8 @@ namespace Swift {
*
* Particularly - a Bare JID is a JID without a resource part.
*
+ * A JID can be invalid (when isValid() returns false). No member methods are
+ * guaranteed to work correctly if they do.
*/
class JID {
public:
@@ -82,7 +84,6 @@ namespace Swift {
/**
* e.g. JID("node@domain").getDomain() == "domain"
- * @return could be empty.
*/
const std::string& getDomain() const {
return domain_;