From 0291d2ee4585cb7f81764035f247b6b1ffe87376 Mon Sep 17 00:00:00 2001 From: john30 Date: Sun, 19 Feb 2017 12:53:02 +0100 Subject: [PATCH] documentation --- src/lib/ebus/data.h | 1 + src/lib/ebus/symbol.h | 1 + 2 files changed, 2 insertions(+) diff --git a/src/lib/ebus/data.h b/src/lib/ebus/data.h index 720a8e48..c4021a55 100644 --- a/src/lib/ebus/data.h +++ b/src/lib/ebus/data.h @@ -104,6 +104,7 @@ class DataField { /** * Return the name of the specified day. + * @param day the day (between 0 and 6). * @return the name of the specified day. */ static string getDayName(int day); diff --git a/src/lib/ebus/symbol.h b/src/lib/ebus/symbol.h index 30d511e0..ed5415ab 100644 --- a/src/lib/ebus/symbol.h +++ b/src/lib/ebus/symbol.h @@ -106,6 +106,7 @@ class SymbolString { * Return the symbols as hex string. * @param unescape whether to unescape an escaped instance. * @param skipLastSymbol whether to skip the last symbol (probably the CRC). + * @param skipFirstSymbols the number of first symbols to skip. * @return the symbols as hex string. */ const string getDataStr(const bool unescape = true, const bool skipLastSymbol = true,