Fixes and tweaks for C++ API reference docs generation

This commit is contained in:
Wojciech Figat
2021-12-01 17:59:28 +01:00
parent aacc336c2c
commit 653c209567
10 changed files with 24 additions and 7 deletions

View File

@@ -10,6 +10,8 @@
/// <summary>
/// Template for dynamic array with variable capacity.
/// </summary>
/// <typeparam name="T">The type of elements in the array.</typeparam>
/// <typeparam name="AllocationType">The type of memory allocator.</typeparam>
template<typename T, typename AllocationType = HeapAllocation>
API_CLASS(InBuild) class Array
{

View File

@@ -10,6 +10,9 @@
/// <summary>
/// Template for unordered dictionary with mapped key with value pairs.
/// </summary>
/// <typeparam name="KeyType">The type of the keys in the dictionary.</typeparam>
/// <typeparam name="ValueType">The type of the values in the dictionary.</typeparam>
/// <typeparam name="AllocationType">The type of memory allocator.</typeparam>
template<typename KeyType, typename ValueType, typename AllocationType = HeapAllocation>
API_CLASS(InBuild) class Dictionary
{

View File

@@ -11,6 +11,7 @@
/// <summary>
/// Template for unordered set of values (without duplicates with O(1) lookup access).
/// </summary>
/// <typeparam name="T">The type of elements in the set.</typeparam>
template<typename T>
API_CLASS(InBuild) class HashSet
{

View File

@@ -5,9 +5,9 @@
#include "../Types/BaseTypes.h"
#include "Engine/Platform/Platform.h"
/// <summanry>
/// <summary>
/// Small buffer for samples used to calculate min/max/avg values.
/// </summanry>
/// </summary>
template<typename T, int32 Size>
class SamplesBuffer
{

View File

@@ -51,6 +51,7 @@ public:
/// <summary>
/// Interface for removable Engine objects.
/// </summary>
/// <seealso cref="Object" />
class FLAXENGINE_API RemovableObject : public Object
{
public:

View File

@@ -4,6 +4,8 @@
#include "Engine/Core/Types/BaseTypes.h"
#ifndef DOXYGEN
// @formatter:off
////////////////////////////////////////////////////////////////////////////////////
@@ -435,3 +437,5 @@ template<> struct TIsBitwiseConstructible<uint64, int64> { enum { Value = true }
template<> struct TIsBitwiseConstructible<int64, uint64> { enum { Value = true }; };
// @formatter:on
#endif

View File

@@ -60,12 +60,10 @@ public:
GPUTexture* LocalShadowedLightScattering = nullptr;
uint64 LastFrameVolumetricFog = 0;
struct VolumetricFogData
struct
{
float MaxDistance;
};
VolumetricFogData VolumetricFogData;
} VolumetricFogData;
// Helper buffer with half-resolution depth buffer shared by effects (eg. SSR, Motion Blur). Valid only during frame rendering and on request (see RequestHalfResDepth).
// Should be released if not used for a few frames.

View File

@@ -2,7 +2,7 @@
#pragma once
#if PLATFORM_UNIX
#if PLATFORM_ANDROID
#include "Engine/Platform/Unix/UnixFile.h"

View File

@@ -2,6 +2,8 @@
#pragma once
#if PLATFORM_LINUX
// Hide warning from old headers
#define register
@@ -38,3 +40,5 @@ namespace X11
#undef Status
#undef True
#undef False
#endif

View File

@@ -2,6 +2,8 @@
#pragma once
#if PLATFORM_WINDOWS
#include "Engine/Core/Templates.h"
#include "../Win32/IncludeWindowsHeaders.h"
@@ -332,3 +334,5 @@ bool operator<(const ComPtr<T>& a, const ComPtr<U>& b)
static_assert(__is_base_of(T, U) || __is_base_of(U, T), "'T' and 'U' pointers must be comparable");
return a.Get() < b.Get();
}
#endif