We forgot to add rte_telemetry.h in doxygen:
doc/api/doxy-api-index.md
doc/api/doxy-api.conf.in
We need a section @file at the top of the header file
to make it appear in doxygen.
24/10/2018 18:03, Kevin Laatz:
> --- /dev/null
> +++ b/lib/librte_telemetry/rte_telemetry.h
> @@ -0,0 +1,42 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(c) 2018 Intel Corporation
> + */
> +
> +#include <stdint.h>
> +
> +#ifndef _RTE_TELEMETRY_H_
> +#define _RTE_TELEMETRY_H_
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice
> + *
> + * Initialize Telemetry
> + *
> + * @return
> + * 0 on successful initialisation.
> + * @return
> + * -ENOMEM on memory allocation error
> + * @return
> + * -EPERM on unknown error failure
> + * @return
> + * -EALREADY if Telemetry is already initialised.
> + */
> +int32_t __rte_experimental
> +rte_telemetry_init(void);
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change without prior notice
> + *
> + * Clean up and free memory.
> + *
> + * @return
> + * 0 on success
> + * @return
> + * -EPERM on failure
> + */
> +int32_t __rte_experimental
> +rte_telemetry_cleanup(void);
> +
> +#endif
