From 798affe0ef9b2542b6a9bf2bd6233d2bf5b25bf4 Mon Sep 17 00:00:00 2001 From: mvglasow Date: Mon, 21 Jul 2025 22:36:04 +0300 Subject: [PATCH] [traffxml] Documentation Signed-off-by: mvglasow --- traffxml/traff_model_xml.hpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/traffxml/traff_model_xml.hpp b/traffxml/traff_model_xml.hpp index 68c5bb8e7..530210002 100644 --- a/traffxml/traff_model_xml.hpp +++ b/traffxml/traff_model_xml.hpp @@ -41,6 +41,8 @@ namespace traffxml * a child of `message` and holds decoded traffic coloring. In order to parse it, `dataSource` must * be specified. If `dataSource` is `nullopt`, coloring will be ignored. It is recommended to pass * `dataSource` if, and only if, parsing an XML stream that is expected to contain traffic coloring. + * This is only expected to occur in cached data. TraFF from external sources is not expected to + * contain `mwm_coloring` elements and souch information should be ignored in feeds from outside. * * @note To pass a reference to the framework data source (assuming the `framework` is the framework * instance), use `std::cref(framework.GetDataSource())`.