From e24ff7b2639ca1ba48d052f22941b64f1eff6d11 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Thu, 28 Jan 2021 13:08:51 +0800 Subject: [PATCH] osd/PeeringState: document prepare_stats_for_publish() document its parameters Signed-off-by: Kefu Chai --- src/osd/PeeringState.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/osd/PeeringState.h b/src/osd/PeeringState.h index a74b65eafa6ac..2cae797d62d10 100644 --- a/src/osd/PeeringState.h +++ b/src/osd/PeeringState.h @@ -1825,6 +1825,12 @@ public: * * Returns updated pg_stat_t if stats have changed since * pg_stats_publish adding in unstable_stats. + * + * @param pg_stats_publish the latest pg_stat possessed by caller + * @param unstable_stats additional stats which should be included in the + * returned stats + * @return the up to date stats if it is different from the specfied + * @c pg_stats_publish */ std::optional prepare_stats_for_publish( const std::optional &pg_stats_publish, -- 2.39.5