drifty/comaps
1
0
Fork 0
mirror of https://codeberg.org/comaps/comaps synced 2025-12-24 06:53:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[traffxml] Documentation

Browse Source 
Signed-off-by: mvglasow <michael -at- vonglasow.com>
This commit is contained in:
mvglasow
2025-07-21 22:36:04 +03:00
parent 93a1f9d1a6
commit 798affe0ef
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
traffxml/traff_model_xml.hpp
View File

@@ -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())`.