X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.core%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fcore%2Ftypes%2FBit.java;h=da7b8c910a7cda3b3393e7ae0e7a2917ff706165;hb=91969fbb8e1a846c21cdfe6dc7e2b20534d86119;hp=8bff357a1cf02cd41e75b0b8f440765f0255e1b1;hpb=3e6ac3d7fd389191d02c1c6982fbf093421ce4f2;p=Mograsim.git

diff --git a/net.mograsim.logic.core/src/net/mograsim/logic/core/types/Bit.java b/net.mograsim.logic.core/src/net/mograsim/logic/core/types/Bit.java
index 8bff357a..da7b8c91 100644
--- a/net.mograsim.logic.core/src/net/mograsim/logic/core/types/Bit.java
+++ b/net.mograsim.logic.core/src/net/mograsim/logic/core/types/Bit.java
@@ -18,6 +18,11 @@ public enum Bit implements StrictLogicType<Bit>
 		this.symbol = symbol;
 	}
 
+	/**
+	 * Returns if the Bit is binary, this is only true for <code>ZERO</code> and <code>ONE</code>.
+	 * 
+	 * @return true if and only if <code>this == ONE || this == ZERO</code>
+	 */
 	public boolean isBinary()
 	{
 		return this == ONE || this == ZERO;