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.

Sign up for GitHub

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

Jump to bottom

Use RAII for the DocumentManager #95

Open
webern opened this issue May 12, 2020 · 0 comments
Open

Use RAII for the DocumentManager #95

webern opened this issue May 12, 2020 · 0 comments
Labels
breaking fixes or implementation that require breaking changes feature new feature request

Comments

@webern
Copy link
Owner

webern commented May 12, 2020

The DocumentManager is a weird concept. Explain why it exists and how to use it early in the Readme and in the code itself.

For extra credit, return an RAII object instead of a document ID so that leaks won't ever happen.

e.g. std::unique_ptr<mx::api::Document> createFromFile( "/some/file.xml" ).
@webern webern added documentation feature new feature request labels May 12, 2020
@webern webern added the breaking fixes or implementation that require breaking changes label Jun 13, 2020
@webern webern changed the title Prominently Document the DocumentManager Use RAII for the DocumentManager Jun 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
breaking fixes or implementation that require breaking changes feature new feature request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@webern