Improve the documentation regarding possible return values. Signed-off-by: Mike Holmes <mike.hol...@linaro.org> --- platform/linux-generic/include/api/odp_system_info.h | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/platform/linux-generic/include/api/odp_system_info.h b/platform/linux-generic/include/api/odp_system_info.h index bcd08d7..28ce669 100644 --- a/platform/linux-generic/include/api/odp_system_info.h +++ b/platform/linux-generic/include/api/odp_system_info.h @@ -28,28 +28,34 @@ extern "C" { /** * CPU frequency in Hz * - * @return CPU frequency in Hz + * @retval CPU frequency in Hz + * @retval 0 on error */ uint64_t odp_sys_cpu_hz(void); /** * Huge page size in bytes * - * @return Huge page size in bytes + * @retval Huge page size in bytes + * @retval 0 on error */ uint64_t odp_sys_huge_page_size(void); /** * Page size in bytes * - * @return Page size in bytes + * This is set at compile time via ODP_PAGE_SIZE + * @retval Page size in bytes + * */ uint64_t odp_sys_page_size(void); /** * CPU model name * - * @return Pointer to CPU model name string + * @note max size is 127 chars + null termination + * @retval Pointer to CPU model name string + * @retval null teminated string on failure */ const char *odp_sys_cpu_model_str(void); @@ -63,7 +69,10 @@ int odp_sys_cache_line_size(void); /** * Core count * - * @return Core count + * @note The total physical number of cores, the current number avalable might be less. + * + * @retval Core count + * @retval 0 on error */ int odp_sys_core_count(void); -- 2.1.0 _______________________________________________ lng-odp mailing list lng-odp@lists.linaro.org http://lists.linaro.org/mailman/listinfo/lng-odp