clarify docstring

This commit is contained in:
Markus Teich 2016-10-13 23:39:52 +02:00
parent 79d4275619
commit 45b930823c

View File

@ -540,8 +540,8 @@ smc_init3 (uint16_t size1, uint16_t size2, uint16_t size3)
/** /**
* smc_sums_partial calculates sums up until the current index and stores them * smc_sums_partial calculates sums up until and including the current index and
* in @a out. \f$\forall i \leq len: out_i=\sum_{h=1}^iin_h\f$ * stores them in @a out. \f$\forall i \leq len: out_i=\sum_{h=1}^iin_h\f$
* *
* @param[out] out Where to store the resulting sums. Points must already be * @param[out] out Where to store the resulting sums. Points must already be
* initialized beforehand. * initialized beforehand.