Clarifying comments

bramble-core/src/main/java/org/briarproject/bramble/crypto/StreamEncrypterImpl.java

@@ -25,6 +25,9 @@ import static org.briarproject.bramble.api.transport.TransportConstants.STREAM_H
 import static org.briarproject.bramble.util.ByteUtils.INT_16_BYTES;
 import static org.briarproject.bramble.util.ByteUtils.INT_64_BYTES;
 
+/**
+ * See the BTP-Specs to understand whats going on here
+ */
 @NotThreadSafe
 @NotNullByDefault
 class StreamEncrypterImpl implements StreamEncrypter {
@@ -81,9 +84,9 @@ class StreamEncrypterImpl implements StreamEncrypter {
 		FrameEncoder.encodeNonce(frameNonce, frameNumber, true);
 		try {
 			cipher.init(true, frameKey, frameNonce);
-			int encrypted = cipher.process(frameHeader, 0,
+			int encryptedLength = cipher.process(frameHeader, 0,
 					FRAME_HEADER_PLAINTEXT_LENGTH, frameCiphertext, 0);
-			if (encrypted != FRAME_HEADER_LENGTH) throw new RuntimeException();
+			if (encryptedLength != FRAME_HEADER_LENGTH) throw new RuntimeException();
 		} catch (GeneralSecurityException badCipher) {
 			throw new RuntimeException(badCipher);
 		}
@@ -129,10 +132,10 @@ class StreamEncrypterImpl implements StreamEncrypter {
 		// Encrypt and authenticate the stream header key
 		try {
 			cipher.init(true, streamHeaderKey, streamHeaderNonce);
-			int encrypted = cipher.process(streamHeaderPlaintext, 0,
+			int encryptedLength = cipher.process(streamHeaderPlaintext, 0,
 					STREAM_HEADER_PLAINTEXT_LENGTH, streamHeaderCiphertext,
 					STREAM_HEADER_NONCE_LENGTH);
-			if (encrypted != STREAM_HEADER_PLAINTEXT_LENGTH + MAC_LENGTH)
+			if (encryptedLength != STREAM_HEADER_PLAINTEXT_LENGTH + MAC_LENGTH)
 				throw new RuntimeException();
 		} catch (GeneralSecurityException badCipher) {
 			throw new RuntimeException(badCipher);

bramble-core/src/main/java/org/briarproject/bramble/sync/SyncRecordWriterImpl.java

@@ -26,6 +26,10 @@ import static org.briarproject.bramble.api.sync.RecordTypes.REQUEST;
 import static org.briarproject.bramble.api.sync.RecordTypes.VERSIONS;
 import static org.briarproject.bramble.api.sync.SyncConstants.PROTOCOL_VERSION;
 
+/**
+ * see the BSP-Specs
+ */
+
 @NotThreadSafe
 @NotNullByDefault
 class SyncRecordWriterImpl implements SyncRecordWriter {

bramble-core/src/main/java/org/briarproject/bramble/transport/StreamWriterImpl.java

@@ -22,7 +22,7 @@ class StreamWriterImpl extends OutputStream implements StreamWriter {
 
 	private final StreamEncrypter encrypter;
 	private final byte[] payload;
-
+	///@var length Stores how long the content that is currently in the buffer "payload" is.
 	private int length = 0;
 
 	StreamWriterImpl(StreamEncrypter encrypter) {
@@ -68,7 +68,8 @@ class StreamWriterImpl extends OutputStream implements StreamWriter {
 
 	@Override
 	public void write(byte[] b, int off, int len) throws IOException {
-		int available = payload.length - length;
+		//Frame Segmentation
+		int available = payload.length - length; // available = How much free space ther is at the end of the buffer "payload"
 		while (available <= len) {
 			System.arraycopy(b, off, payload, length, available);
 			length += available;

bramble-core/src/main/java/org/briarproject/bramble/transport/TransportKeyManagerImpl.java

@@ -63,6 +63,9 @@ class TransportKeyManagerImpl implements TransportKeyManager {
 
 	@GuardedBy("lock")
 	private final Map<KeySetId, MutableTransportKeySet> keys = new HashMap<>();
+	/**
+	 * List of all Tags
+	 */
 	@GuardedBy("lock")
 	private final Map<Bytes, TagContext> inContexts = new HashMap<>();
 	@GuardedBy("lock")