Skip to content
Snippets Groups Projects
Commit 27f2fd11 authored by Jaswant Panchumarti (Kitware)'s avatar Jaswant Panchumarti (Kitware)
Browse files

Document removal of nlohmannjson from CommonCore public API

parent 88656d5e
No related branches found
No related tags found
No related merge requests found
......@@ -45,6 +45,13 @@
* Unless `Modified` is called, various cached entities, like array range,
* map created for `LookupValue` may become obsolete and yield incorrect results.
*
* @warning
* In VTK 9.4, new method `nlohmann::json vtkAbstractArray::SerializeValues()` was
* introduced which required exposing symbols from
* VTK::nlohmannjson library in public API. This method will be removed in VTK 9.5 as it caused
* difficulty for downstream projects that linked to a different nlohmannjson. It cannot be
* deprecated because doing so prevents fixing the underlying issue.
*
* @sa
* vtkDataArray vtkStringArray vtkCellArray
*/
......
# Remove usage of the nlohmannjson library from public facing API
The `nlohmann::json vtkAbstractArray::SerializeValues()` method is now removed
as the public exposure of VTK's vendored `nlohmannjson` library caused difficulty for downstream projects that link to a different nlohmannjson.
These methods were added in [vtk/vtk!11163](https://gitlab.kitware.com/vtk/vtk/-/merge_requests/11163) which was released in 9.4. That merge
request has now been reverted. These methods are removed (instead of deprecation) because deprecation would prevent fixing the problem.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment