Skip to content

Commit 5bcf977

Browse files
Updated Basic Types documentation
1 parent 366c8e4 commit 5bcf977

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Primitives/interface/BasicTypes.h

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 Diligent Graphics LLC
2+
* Copyright 2019-2025 Diligent Graphics LLC
33
* Copyright 2015-2019 Egor Yusov
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,6 +27,9 @@
2727

2828
#pragma once
2929

30+
/// \file
31+
/// Defines basic types used in the engine
32+
3033
#include "CommonDefinitions.h"
3134

3235
#if DILIGENT_C_INTERFACE || defined(DILIGENT_SHARP_GEN)
@@ -51,9 +54,9 @@ typedef uint32_t Uint32; ///< 32-bit unsigned integer
5154
typedef uint16_t Uint16; ///< 16-bit unsigned integer
5255
typedef uint8_t Uint8; ///< 8-bit unsigned integer
5356

54-
typedef size_t SizeType;
55-
typedef void* PVoid;
56-
typedef const void* CPVoid;
57+
typedef size_t SizeType; ///< Size type
58+
typedef void* PVoid; ///< Pointer to void
59+
typedef const void* CPVoid; ///< Pointer to const void
5760

5861
typedef bool Bool; ///< Boolean
5962

0 commit comments

Comments
 (0)