Adding documentation to the allocated class hierarchy, base classes edition #1
Conversation
|
Tagging @SaschaWillems |
|
Thanks a lot for this. Makes it a lot easier to follow and understand the code. Very much appreciated 👍🏻 |
| */ | ||
| void destroy_image(ImageType image); | ||
| /** | ||
| * @brief Clears the internal state. Can be overridden by derived classes to perform additional cleanup of members. |
There was a problem hiding this comment.
Can it be overridden? It's not marked as virtual.
There was a problem hiding this comment.
I don't think there's a need for this to be overriden.
There was a problem hiding this comment.
I don't think so either. So please remove that comment.
| protected: | ||
| /** | ||
| * @brief The VMA-specific constructor for new objects. This should only be visible to derived classes. | ||
| * @tparam Args Additional constructor arguments needed for the derived class. Typically a `VkImageCreateInfo` or `VkBufferCreateInfo` struct. |
There was a problem hiding this comment.
This is not an error or typo. @tparam is specifically for template parameters.
…base classes edition
|
let me know if there's anything else you want in terms of documentation. I could try to add some notes and links to the VMA docs at the appropriate places for the builder classes, but I'd rather do that in a distinct PR. if you're happy with these changes so far let me know and I'll rebase the "fixup" commits into a single commit so you can merge it without the mess. I only kept it as fixups so you could see the incremental changes for each one. |
Here's a first pass at adding more developer comments to the allocated base classes. I haven't done the derived classes yet, but I wanted to get a sense of whether this was what was being looked for.
Prompted by KhronosGroup#1193