Add documentation as per GoDoc specs

Author: coderick14

ALU/ALU.go

@@ -1,40 +1,31 @@
 package ALU
 
-/*
- * Function to perform signed addition
- */
+//Function to perform signed addition of two int64 numbers.
 func Adder(val1, val2 int64) int64 {
 	return val1 + val2
 }
 
-/*
- * Function to perform logical AND operation
- */
 
+//Function to perform logical AND operation of two int64 numbers.
 func LogicalAND(val1, val2 int64) int64 {
 	return val1 & val2
 }
 
-/*
- * Function to perform logical OR operation
- */
 
+//Function to perform logical OR operation of two int64 numbers.
 func LogicalOR(val1, val2 int64) int64 {
 	return val1 | val2
 }
 
-/*
- * Function to perform logical XOR operation
- */
 
+//Function to perform logical XOR operation of two int64 numbers.
 func LogicalXOR(val1, val2 int64) int64 {
 	return val1 ^ val2
 }
 
-/*
- * Function to perform unsigned addition
- * Used only for setting Carry flag
- */
+
+//Function to perform unsigned addition of two uint64 numbers.
+//Used only for setting Carry flag.
 func UnsignedAdder(val1, val2 uint64) uint64 {
 	return val1 + val2
 }

Memory/DataMemory.go

@@ -18,30 +18,21 @@ var registers, buffer [32]int64
 
 var flagNegative, flagZero, flagOverflow, flagCarry bool
 
-/*
- * method to initiate register values
- */
-
+// method to initiate register values.
 func InitRegisters() {
 	registers[XZR] = 0
 	registers[SP] = MEMORY_SIZE * 4
 }
 
-/*
- * function to store register values in a buffer
- */
-
+// function to store register values in a buffer.
 func SaveRegisters() {
 	var i int
 	for i = 0; i < 32; i++ {
 		buffer[i] = registers[i]
 	}
 }
 
-/*
- * function to show register values
- */
-
+// function to pretty print register values to terminal.
 func ShowRegisters(showAll bool) {
 	var i int
 	var hasUpdated bool = false
@@ -79,41 +70,29 @@ func ShowRegisters(showAll bool) {
 	}
 }
 
-/*
- * Method to read data from memory
- * Guarantees mutually exclusive access
- */
-
+// Method to read data from memory.
+// Guarantees mutually exclusive access.
 func (dataMemory *DataMemory) read(address uint64) int32 {
 	dataMemory.RLock()
 	value := dataMemory.Memory[address]
 	dataMemory.RUnlock()
 	return value
 }
 
-/*
- * Method to write data to memory
- * Guarantees mutually exclusive access
- */
-
+// Method to write data to memory.
+// Guarantees mutually exclusive access.
 func (dataMemory *DataMemory) write(address uint64, value int32) {
 	dataMemory.Lock()
 	dataMemory.Memory[address] = value
 	dataMemory.Unlock()
 }
 
-/*
- * Function to read from register
- */
-
+// Function to read from register and return its value.
 func getRegisterValue(registerIndex uint) int64 {
 	return registers[registerIndex]
 }
 
-/*
- * Function to write to register
- */
-
+// Function to write to register.
 func setRegisterValue(registerIndex uint, value int64) {
 	registers[registerIndex] = value
 }