From 7c3f732c46ebfee90ffc180c9d59c7af1d96a373 Mon Sep 17 00:00:00 2001
From: Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com>
Date: Wed, 24 Jul 2024 12:42:00 +0200
Subject: analyse_context: Add missing documentation

---
 src/buildtool/main/analyse_context.hpp | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src')

diff --git a/src/buildtool/main/analyse_context.hpp b/src/buildtool/main/analyse_context.hpp
index 4fe7381e..cb240cef 100644
--- a/src/buildtool/main/analyse_context.hpp
+++ b/src/buildtool/main/analyse_context.hpp
@@ -22,6 +22,8 @@
 #include "src/buildtool/serve_api/remote/serve_api.hpp"
 #include "src/buildtool/storage/storage.hpp"
 
+/// \brief Aggregate to be passed during analysis.
+/// \note No field is stored as const ref to avoid binding to temporaries.
 struct AnalyseContext final {
     gsl::not_null<RepositoryConfig const*> const repo_config;
     gsl::not_null<Storage const*> const storage;
-- 
cgit v1.2.3