[2831] described implementation-specific differences of setNamedAddress.

src/lib/util/memory_segment_local.h

@@ -76,6 +76,11 @@ public:
     ///
     /// This version does not validate the given address to see whether it
     /// belongs to this segment.
+    ///
+    /// This implementation of this method always returns \c false (but the
+    /// application should expect a return value of \c true unless it knows
+    /// the memory segment class is \c MemorySegmentLocal and needs to
+    /// exploit the fact).
     virtual bool setNamedAddress(const char* name, void* addr);
 
     /// \brief Local segment version of clearNamedAddress.

src/lib/util/memory_segment_mapped.h

@@ -134,7 +134,8 @@ public:
     /// This implementation detects if \c addr is invalid (see the base class
     /// description) and throws \c MemorySegmentError in that case.
     ///
-    /// This version can actually return true.
+    /// This version can actually return true (see also \c MemorySegmentLocal
+    /// version of the method).
     ///
     /// This method cannot be called if the segment object is created in the
     /// read-only mode; in that case InvalidOperation will be thrown.