From a7128ffa0451bfec24812a273f54590c1ae6be22 Mon Sep 17 00:00:00 2001
From: Marek Bel <marek.bel@posta.cz>
Date: Fri, 4 Jan 2019 19:56:15 +0100
Subject: [PATCH] Comment.

---
 Firmware/AutoDeplete.cpp | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Firmware/AutoDeplete.cpp b/Firmware/AutoDeplete.cpp
index 9593a1fe..9c4340f0 100644
--- a/Firmware/AutoDeplete.cpp
+++ b/Firmware/AutoDeplete.cpp
@@ -12,6 +12,8 @@
 static uint8_t depleted;
 static const uint8_t filamentCount = 5;
 
+//! @return binary 1 for all filaments
+//! @par fCount number of filaments
 static constexpr uint8_t allDepleted(uint8_t fCount)
 {
     return fCount == 1 ? 1 : ((1 << (fCount - 1)) | allDepleted(fCount - 1));