Skip to content
Snippets Groups Projects
Verified Commit 5abd98b4 authored by Tobias Frisch's avatar Tobias Frisch
Browse files

Adjusted the doxygen comments of the handles

parent 2344c726
No related branches found
No related tags found
1 merge request!97Resolve "Dokumentation vervollständigen"
...@@ -33,8 +33,8 @@ namespace vkcv ...@@ -33,8 +33,8 @@ namespace vkcv
* @brief Constructor of a valid handle with an * @brief Constructor of a valid handle with an
* unique id and an optional destroy callback. * unique id and an optional destroy callback.
* *
* @param id Unique handle id * @param[in] id Unique handle id
* @param destroy Destroy callback (optional) * @param[in] destroy Destroy callback (optional)
*/ */
explicit Handle(uint64_t id, const HandleDestroyFunction& destroy = nullptr); explicit Handle(uint64_t id, const HandleDestroyFunction& destroy = nullptr);
...@@ -79,6 +79,14 @@ namespace vkcv ...@@ -79,6 +79,14 @@ namespace vkcv
}; };
/**
* @brief Stream operator to print a handle into an output
* stream.
*
* @param[out] out Output stream
* @param[in] handle
* @return Output stream after printing
*/
std::ostream& operator << (std::ostream& out, const Handle& handle); std::ostream& operator << (std::ostream& out, const Handle& handle);
// Handle returned for any buffer created with the core/context objects // Handle returned for any buffer created with the core/context objects
...@@ -141,7 +149,7 @@ namespace vkcv ...@@ -141,7 +149,7 @@ namespace vkcv
* @brief Creates a valid image handle to represent a swapchain image * @brief Creates a valid image handle to represent a swapchain image
* using an optional destroy callback. * using an optional destroy callback.
* *
* @param destroy Destroy callback (optional) * @param[in] destroy Destroy callback (optional)
* @return New swapchain image handle * @return New swapchain image handle
*/ */
static ImageHandle createSwapchainImageHandle(const HandleDestroyFunction& destroy = nullptr); static ImageHandle createSwapchainImageHandle(const HandleDestroyFunction& destroy = nullptr);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment