Browse Source

Update documentation.

Marek Bel 6 years ago
parent
commit
2607a0c4ed
1 changed files with 26 additions and 12 deletions
  1. 26 12
      Firmware/ultralcd.cpp

+ 26 - 12
Firmware/ultralcd.cpp

@@ -1,3 +1,5 @@
+//! @file
+
 #include "temperature.h"
 #include "ultralcd.h"
 #include "fsensor.h"
@@ -2462,16 +2464,33 @@ static void lcd_LoadFilament()
   }
 }
 
+//! @brief Show filament used a print time
+//!
+//! If printing current print statistics are shown
+//!
+//! @code{.unparsed}
+//! |01234567890123456789|
+//! |Filament used:      |
+//! |         00.00m     |
+//! |Print time:         |
+//! |        00h 00m 00s |
+//! ----------------------
+//! @endcode
+//!
+//! If not printing, total statistics are shown
+//!
+//! @code{.unparsed}
+//! |01234567890123456789|
+//! |Total filament :    |
+//! |           000.00 m |
+//! |Total print time :  |
+//! |     00d :00h :00 m |
+//! ----------------------
+//! @endcode
 void lcd_menu_statistics()
 {
 	if (IS_SD_PRINTING)
 	{
-//|01234567890123456789|
-//|Filament used:      |
-//|      000m 00.000cm |
-//|Print time:         |
-//|        00h 00m 00s |
-//----------------------
 		const float _met = ((float)total_filament_used) / (100000.f);
 		const uint32_t _t = (millis() - starttime) / 1000ul;
 		const int _h = _t / 3600;
@@ -2504,12 +2523,7 @@ void lcd_menu_statistics()
 		_days = _time / 1440;
 		_hours = (_time - (_days * 1440)) / 60;
 		_minutes = _time - ((_days * 1440) + (_hours * 60));
-//|01234567890123456789|
-//|Total filament :    |
-//|           000.00 m |
-//|Total print time :  |
-//|     00d :00h :00 m |
-//----------------------
+
 		lcd_printf_P(_N(
 		  ESC_2J
 		  "%S :"