diff options
| author | Matias Elo <matias.elo@nokia.com> | 2016-10-14 11:49:08 +0300 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2017-01-12 17:57:42 +0300 |
| commit | ad7f8f4ea11a8e40d853cd9b2b0bc3e6f7876a8b (patch) | |
| tree | 756fd398747cba8c623a45431e4a0d9bbc4ef89f /include/odp/api/spec/timer.h | |
| parent | 50cfbff244a1fa29314520eb9ca9bdf5df445df6 (diff) | |
api: improve name argument definitions in *_create() functions
The current APIs don't always define valid name argument values. Fix this
by stating when NULL is a valid value and when the name string doesn't have
to be unique.
Signed-off-by: Matias Elo <matias.elo@nokia.com>
Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include/odp/api/spec/timer.h')
| -rw-r--r-- | include/odp/api/spec/timer.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index df3718927..49221c439 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -108,7 +108,10 @@ typedef struct { /** * Create a timer pool * - * @param name Name of the timer pool. The string will be copied. + * The use of pool name is optional. Unique names are not required. + * + * @param name Name of the timer pool or NULL. Maximum string length is + * ODP_TIMER_POOL_NAME_LEN. * @param params Timer pool parameters. The content will be copied. * * @return Timer pool handle on success |