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

Document that it is required to call initLib() #179

Closed
Willem3141 opened this Issue Feb 12, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@Willem3141

Willem3141 commented Feb 12, 2018

I'm currently using Ipelib from my C++ program to write Ipe files. I was getting a strange crash from just calling the Document() constructor. After debugging and going through the documentation, I found the method Platform::initLib(). I included a call to that method, and the problem was solved (the crash apparently happened because the locale was not set).

The documentation for Platform::initLib() indeed states that it is required to call this method before doing anything with Ipelib, but (as far as I found) there is no indication of this elsewhere. Because omitting this method call leads to a seemingly unrelated crash, this is quite hard to debug. Therefore I think it makes sense to mention this on the documentation main page, for example something like

Before using Ipelib, make sure to initialize the library by calling Platform::initLib(). See the documentation for that method for more details.

@otfried

This comment has been minimized.

Owner

otfried commented Sep 17, 2018

Added to documentation in 7.2.8.

@otfried otfried closed this Sep 17, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment