Diff: main.cpp

Revision:

1:1ee11539cc43

Parent:

0:ed4063a0a4d5

Child:

2:90d31841523a

--- a/main.cpp	Wed Jan 13 10:26:45 2021 +0000
+++ b/main.cpp	Wed Jan 13 10:36:30 2021 +0000
@@ -1,4 +1,4 @@
-/*
+/**
 @file main.cpp
 @brief Light Control System to automatically dimmer or increase light levels depending on registered light intensity.
 
@@ -14,8 +14,16 @@
 char room[31];
 //bool is_set = false;
 
+/**
+Declaration of the function (prototype)
+@date 1/13/2021
+*/
 void setup_set_room_and_building();
 
+/**
+Confirm if happy with inputted information
+@date 1/13/2021
+*/
 void setup_confirm()
 {
     char answer;
@@ -33,6 +41,10 @@
     printf("setup_confirm function end\n");
 }
 
+/**
+Show inputted information, and call setup_confirm to ask for confirmation.
+@date 1/13/2021
+*/
 void setup_show_settings()
 {
     printf("Is this correct?\n");
@@ -41,6 +53,10 @@
     setup_confirm();  
 }
 
+/**
+Function to set building and room. Will call setup_show_settings to show what has been inputted.
+@date 1/13/2021
+*/
 void setup_set_room_and_building()
 {
     printf("Please set the building (maximum 30 characters): ");
@@ -50,6 +66,10 @@
     setup_show_settings();
 }
 
+/**
+Function to run the initial setup process.
+@date 1/13/2021
+*/
 void setup_run_setup()
 {
     printf("Welcome to the Light Control System initial setup process\n");