Skip to content

Commit e851acd

Browse files
committed
Fix formatting and doxygen issue.
1 parent 918d848 commit e851acd

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

framework/builder_base.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@
2222
#include "vulkan_type_mapping.h"
2323
#include <vulkan/vulkan.hpp>
2424

25-
namespace vkb {
26-
27-
namespace allocated {
25+
namespace vkb
26+
{
2827

28+
namespace allocated
29+
{
2930

3031
/**
3132
* @brief Many Vulkan resource types (most notably Images and to a lesser extent Buffers)
@@ -46,7 +47,7 @@ namespace allocated {
4647
* For instance, the VMA create and usage flags are set here, but the image or buffer
4748
* usage flags are handled in the derived builder classes specific to those types.
4849
*
49-
* @example The following is an example of how the builder pattern is used in the codebase:
50+
* The following is an example of how the builder pattern is used in the codebase:
5051
```cpp
5152
vkb::core::ImageBuilder(VkExtent3D{grid_width, grid_height, 1})
5253
.with_format(VK_FORMAT_R8G8B8A8_UNORM)
@@ -258,6 +259,5 @@ inline BuilderType &BuilderBase<bindingType, BuilderType, CreateInfoType>::with_
258259
return *static_cast<BuilderType *>(this);
259260
}
260261

261-
} // namespace allocated
262-
} // namespace vkb
263-
262+
} // namespace allocated
263+
} // namespace vkb

framework/core/allocated.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ class Allocated : public vkb::core::VulkanResource<bindingType, HandleType>
141141
protected:
142142
/**
143143
* @brief The VMA-specific constructor for new objects. This should only be visible to derived classes.
144-
* @tparam Args Additional constructor arguments needed for the derived class. Typically a `VkImageCreateInfo` or `VkBufferCreateInfo` struct.
145144
* @param allocation_create_info All of the non-resource-specific information needed by the VMA to allocate the memory.
145+
* @param args Additional constructor arguments needed for the derived class. Typically a `VkImageCreateInfo` or `VkBufferCreateInfo` struct.
146146
*/
147147
template <typename... Args>
148148
Allocated(const VmaAllocationCreateInfo &allocation_create_info, Args &&...args);
@@ -346,22 +346,22 @@ class Allocated : public vkb::core::VulkanResource<bindingType, HandleType>
346346
* @brief A pointer to the allocation memory, if the memory is HOST_VISIBLE and is currently (or persistently) mapped.
347347
* Contains null otherwise.
348348
*/
349-
uint8_t *mapped_data = nullptr;
349+
uint8_t *mapped_data = nullptr;
350350
/**
351351
* @brief This flag is set to true if the memory is coherent and doesn't need to be flushed after writes.
352352
*
353353
* @note This is initialized at allocation time to avoid subsequent need to call a function to fetch the
354354
* allocation information from the VMA, since this property won't change for the lifetime of the allocation.
355355
*/
356-
bool coherent = false;
356+
bool coherent = false;
357357
/**
358358
* @brief This flag is set to true if the memory is persistently mapped (i.e. not just HOST_VISIBLE, but available
359359
* as a pointer to the application for the lifetime of the allocation).
360360
*
361361
* @note This is initialized at allocation time to avoid subsequent need to call a function to fetch the
362362
* allocation information from the VMA, since this property won't change for the lifetime of the allocation.
363363
*/
364-
bool persistent = false;
364+
bool persistent = false;
365365
};
366366

367367
template <vkb::BindingType bindingType, typename HandleType>

framework/core/hpp_image.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ class HPPImageView;
3131
class HPPImage;
3232
using HPPImagePtr = std::unique_ptr<HPPImage>;
3333

34-
3534
struct HPPImageBuilder : public vkb::allocated::BuilderBaseCpp<HPPImageBuilder, vk::ImageCreateInfo>
3635
{
3736
private:

0 commit comments

Comments
 (0)