Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove tinyxml2 from public API #189

Closed
scpeters opened this issue Dec 6, 2023 · 2 comments · Fixed by #190
Closed

Remove tinyxml2 from public API #189

scpeters opened this issue Dec 6, 2023 · 2 comments · Fixed by #190

Comments

@scpeters
Copy link
Contributor

scpeters commented Dec 6, 2023

We are upgrading from tinyxml to tinyxml2 in #186 (resolving #185), which will be included in the next major release. An alternate approach to replacing tinyxml2 in #178 also made a change to redact tinyxml2 from the public API, so we should apply that change as well after #186 is merged.

@moooeeeep
Copy link

moooeeeep commented Dec 8, 2023

Did you consider to try to hide the tinyxml2 types with a typedef? Maybe this would help client code with the next upgrade, as they would just continue to use urdf::XMLDocument.

(untested) Example:


namespace urdf{
  using XMLDocument = tinyxml2::XMLDocument;
  ...
  URDFDOM_DLLAPI XMLDocument*  exportURDF(ModelInterfaceSharedPtr &model);
  ...
}

@clalancette
Copy link
Contributor

Did you consider to try to hide the tinyxml2 types with a typedef? Maybe this would help client code with the next upgrade, as they would just continue to use urdf::XMLDocument.

Yeah, we could do that. Honestly, I suspect that all of the APIs that take tinyxml2 APIs are unused, so I'm considering marking them deprecated and eventually removing them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants