From 4dd0b9dc2336b3bb8ab35d9a0d319ca86fbe76eb Mon Sep 17 00:00:00 2001 From: Sandro Welte Date: Thu, 8 Feb 2024 20:51:50 +0100 Subject: [PATCH] refactoring: description added --- src/convert_m_to_ft.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/convert_m_to_ft.h b/src/convert_m_to_ft.h index 6b9317c..3c99725 100644 --- a/src/convert_m_to_ft.h +++ b/src/convert_m_to_ft.h @@ -2,6 +2,13 @@ #ifndef THEADMIRALS_CONVERT_M_TO_FT_H #define THEADMIRALS_CONVERT_M_TO_FT_H +// Convert length from one unit to another +// Parameters: +// value: the value to be converted +// from_unit: the unit to convert from ('m' for meters, 'c' for centimeters, 'i' for inches) +// to_unit: the unit to convert to ('m' for meters, 'c' for centimeters, 'i' for inches) +// Returns: +// The converted length value float convert_length(float value, char from_unit, char to_unit);