Update the KeyInformation Javadoc

RoanH · Feb 5, 2019 · 09f31ab · 09f31ab
1 parent 9acd59a
commit 09f31ab
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/KeysPerSecond/src/me/roan/kps/Main.java b/KeysPerSecond/src/me/roan/kps/Main.java
@@ -2190,6 +2190,14 @@ protected KeyInformation(String name, int code, boolean visible){
 			this.visible = visible;
 		}
 
+		/**
+		 * Changes the display name of this
+		 * key to the given string. If {@link Key}
+		 * panels are active with the same key code
+		 * as this {@link KeyInformation} object
+		 * then their display name is also updated.
+		 * @param name The new display name
+		 */
 		public void setName(String name){
 			this.name = name;
 			keys.getOrDefault(keycode, DUMMY_KEY).name = name;