Doc website #1773
Draft
Doc website #1773
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This format can be understood by doxygen for syntax highlighting.
theHamsta
commented
Jan 22, 2024
| vulkan/vulkan_static_assertions.hpp \ | ||
| vulkan/vulkan_raii.hpp \ | ||
| vulkan/vulkan_structs.hpp \ | ||
| vulkan/vulkan_structs.hpp \ |
There was a problem hiding this comment.
without VulkanSC to make webpage not unnecessary slower for class list. doxygen crashed on VkSharedHandle by encountering an infinite recursion loop when investigating template relations.
theHamsta
commented
Jan 22, 2024
| on: | ||
| push: | ||
| branches: | ||
| - main |
There was a problem hiding this comment.
pushes webpage to gh-pages. In repo, setting this branch can be enabled to serve Github pages.
Alternative would be to publish the documentation in some other location (e.g. Khronous owned) or just leave it for users to build locally.
theHamsta
commented
Jan 22, 2024
| @@ -100,7 +100,7 @@ The scoped enum feature adds type safety to the flags, but also prevents using t | |||
|
|
|||
| As solution Vulkan-Hpp provides a template class `vk::Flags` which brings the standard operations like `&=`, `|=`, `&` and `|` to our scoped enums. Except for the initialization with 0 this class behaves exactly like a normal bitmask with the improvement that it is impossible to set bits not specified by the corresponding enum by accident. Here are a few examples for the bitmask handling: | |||
|
|
|||
| ```c++ | |||
There was a problem hiding this comment.
Doxygen doesn't understand c++ in Markdown, cpp
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial draft to run
doxygenon Vulkan-Hpp to have a documentation website that could be hosted somewhere. Not sure if this is needed/useful.E.g. https://thehamsta.github.io/Vulkan-Hpp/
Vulkan-Hpp samples already have
VULKAN_HPP_KEY_START. Are they already pushed to some kind of documentation website?