comment inconsistent methods

JMRI · Apr 8, 2018 · 6938e1f · 6938e1f
1 parent 2068d9a
commit 6938e1f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/java/src/jmri/jmrit/audio/AbstractAudioSource.java b/java/src/jmri/jmrit/audio/AbstractAudioSource.java
@@ -832,6 +832,10 @@ protected int getFading() {
         return this.fading;
     }
 
+    // note that this doesn't properly implement the 
+    // contract in {@link NamedBean.toString()}, 
+    // which means things like tables and persistance 
+    // might not behave properly.
     @Override
     public String toString() {
         return "Pos: " + this.getPosition().toString()

diff --git a/java/src/jmri/jmrit/logix/Portal.java b/java/src/jmri/jmrit/logix/Portal.java
@@ -625,6 +625,10 @@ public String getDescription() {
     }
 
     @Override
+    // note that this doesn't properly implement the 
+    // contract in {@link NamedBean.toString()}, 
+    // which means things like tables and persistance 
+    // might not behave properly.
     public String toString() {
         StringBuilder sb = new StringBuilder("Portal \"");
         sb.append(getUserName());