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

Clarify which symbols are part of public API and which are implementation details #1205

Open
Hawk777 opened this issue Feb 15, 2022 · 1 comment

Comments

@Hawk777
Copy link

Hawk777 commented Feb 15, 2022

The README explains in general how to use Vulkan-HPP, but it doesn’t really go into details. So, to figure out e.g. individual function signatures, I’ve taken to just browsing the header file. Unfortunately, the header file has very few comments, so I’m not sure which things I discover I’m really allowed to use—which are parts of Vulkan-HPP’s public API, and which are implementation details which are only in the header file for technical reasons (i.e. because Vulkan-HPP is a header-only library so everything is in header files)?

For example, if I have a Result lying around, am I allowed to call throwResultException myself, or is that an implementation detail which might get renamed or deleted in a future version of Vulkan without warning?

It would be good if implementation details were either commented as such, or perhaps put into an impl namespace or something like that.

@Pacheco95
Copy link

Meybe put implementation details in a different namespace, e.g. priv

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

No branches or pull requests

3 participants