From b7749e054cd7d3602553ca01bd1f297fa0840953 Mon Sep 17 00:00:00 2001 From: Brian Harlow Date: Tue, 26 Mar 2019 18:48:30 -0400 Subject: [PATCH] Added documentation for Terminal_ClearScreen function --- include/terminal.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/include/terminal.h b/include/terminal.h index 98c36890..3492e90a 100644 --- a/include/terminal.h +++ b/include/terminal.h @@ -94,6 +94,12 @@ void Terminal_ShowCursor(uint8_t channel); */ void Terminal_SetColor(uint8_t channel, enum term_color color); +/** Function to clear the screen of the terminal + * + * This function will clear all characters written in the terminal. + * + * @param channel UART Channel + */ void Terminal_ClearScreen(uint8_t channel); ///@}