From e43e6f2db8ce45d94fbcaf49aedae690d5f9c57e Mon Sep 17 00:00:00 2001 From: john30 Date: Sat, 7 Mar 2015 13:08:40 +0100 Subject: [PATCH] documentation --- src/lib/ebus/data.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/lib/ebus/data.h b/src/lib/ebus/data.h index cf4da9c4..6ddb6b3e 100644 --- a/src/lib/ebus/data.h +++ b/src/lib/ebus/data.h @@ -220,7 +220,8 @@ public: * @param leadingSeparator whether to prepend a separator before the formatted value. * @param verbose whether to prepend the name, append the unit (if present), and append * the comment in square brackets (if present). - * @param filterName the optional name of a field to limit the output to. + * @param fieldName the optional name of a field to limit the output to. + * @param fieldIndex the optional index of the named field to limit the output to, or -1. * @param separator the separator character between multiple fields. * @return @a RESULT_OK on success (or if the partType does not match), * or @a RESULT_EMPTY if the field was skipped (either ignored or due to @a filterName),