BinghamtonRover / RoverSystem

Pre-2021 Software Repository for the Binghamton University Rover Team
https://binghamtonrover.github.io/RoverSystem/
8 stars 2 forks source link

Network Library Documentation #229

Open krmnino opened 3 years ago

krmnino commented 3 years ago

Add descriptive comments above blocks of code. Comments must be enumerated. Let's start with network.cpp and network.hpp. Find below an example of how comments should be written:

/* 1. Swich focus mode based on key input */
if(key == '1'){
    /* 1.a Iterate over array */
    for(int i = 0; i < 10; i++){
    }
}
else if(key == '2'){
    /* 1.b Iterate over array */
    for(int i = 0; i < 10; i++){
    }
}
/* 2. A function that prints Hello World. Takes no arguments. Returns an integer.
int func(){
    printf("Hello world");
    return 1;
}

Once all comments have been created and enumerated appropriately, add a comment containing all enumerated comments.

/***************************************************************************************
1. Swich focus mode based on key input */
    1.a Iterate over array
    1.b Iterate over array
2. A function that prints Hello World. Takes no arguments. Returns an integer.
***************************************************************************************/