diff --git a/Sources/Jazz2/ContentResolver.h b/Sources/Jazz2/ContentResolver.h index c261e015..c00477f1 100644 --- a/Sources/Jazz2/ContentResolver.h +++ b/Sources/Jazz2/ContentResolver.h @@ -95,12 +95,15 @@ namespace Jazz2 } private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct StringRefEqualTo { inline bool operator()(const Reference& a, const Reference& b) const noexcept { return a.get() == b.get(); } }; +#endif ContentResolver(); diff --git a/Sources/Jazz2/Events/EventMap.h b/Sources/Jazz2/Events/EventMap.h index f9726be4..4b477a03 100644 --- a/Sources/Jazz2/Events/EventMap.h +++ b/Sources/Jazz2/Events/EventMap.h @@ -65,6 +65,8 @@ namespace Jazz2::Events void SerializeResumableToStream(Stream& dest); private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct GeneratorInfo { std::int32_t EventPos; @@ -85,6 +87,7 @@ namespace Jazz2::Events std::uint16_t Id; Vector2f Pos; }; +#endif ILevelHandler* _levelHandler; Vector2i _layoutSize; diff --git a/Sources/Jazz2/Events/EventSpawner.h b/Sources/Jazz2/Events/EventSpawner.h index 53a55c1f..523a2c42 100644 --- a/Sources/Jazz2/Events/EventSpawner.h +++ b/Sources/Jazz2/Events/EventSpawner.h @@ -25,10 +25,13 @@ namespace Jazz2::Events void RegisterSpawnable(EventType type, CreateDelegate create, PreloadDelegate preload = nullptr); private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct SpawnableEvent { CreateDelegate CreateFunction; PreloadDelegate PreloadFunction; }; +#endif ILevelHandler* _levelHandler; HashMap _spawnableEvents; diff --git a/Sources/Jazz2/LevelHandler.h b/Sources/Jazz2/LevelHandler.h index d2048ddc..f5a70e0b 100644 --- a/Sources/Jazz2/LevelHandler.h +++ b/Sources/Jazz2/LevelHandler.h @@ -170,6 +170,7 @@ namespace Jazz2 virtual void SpawnPlayers(const LevelInitialization& levelInit); protected: + /** @brief Describes current input state of a player */ struct PlayerInput { std::uint64_t PressedActions; std::uint64_t PressedActionsLast; diff --git a/Sources/Jazz2/Multiplayer/MultiLevelHandler.h b/Sources/Jazz2/Multiplayer/MultiLevelHandler.h index 02f679dd..eb272f4e 100644 --- a/Sources/Jazz2/Multiplayer/MultiLevelHandler.h +++ b/Sources/Jazz2/Multiplayer/MultiLevelHandler.h @@ -118,6 +118,8 @@ namespace Jazz2::Multiplayer LevelSynchronized }; +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct PeerDesc { Actors::Multiplayer::RemotePlayerOnServer* Player; PeerState State; @@ -126,6 +128,7 @@ namespace Jazz2::Multiplayer PeerDesc() {} PeerDesc(Actors::Multiplayer::RemotePlayerOnServer* player, PeerState state) : Player(player), State(state), LastUpdated(0) {} }; +#endif enum class PlayerFlags { None = 0, @@ -141,6 +144,8 @@ namespace Jazz2::Multiplayer DEFINE_PRIVATE_ENUM_OPERATORS(PlayerFlags); +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct PlayerState { PlayerFlags Flags; std::uint64_t PressedKeys; @@ -157,6 +162,7 @@ namespace Jazz2::Multiplayer Vector2f Pos; std::uint8_t Team; }; +#endif static constexpr float UpdatesPerSecond = 16.0f; // ~62 ms interval static constexpr std::int64_t ServerDelay = 64; diff --git a/Sources/Jazz2/PreferencesCache.h b/Sources/Jazz2/PreferencesCache.h index c91a30af..176d0b60 100644 --- a/Sources/Jazz2/PreferencesCache.h +++ b/Sources/Jazz2/PreferencesCache.h @@ -9,6 +9,7 @@ using namespace nCine; namespace Jazz2 { + /** @brief Rescale mode */ enum class RescaleMode { None, HQ2x, @@ -24,12 +25,14 @@ namespace Jazz2 DEFINE_ENUM_OPERATORS(RescaleMode); + /** @brief Weapon wheel style */ enum class WeaponWheelStyle : std::uint8_t { Disabled, Enabled, EnabledWithAmmoCount }; + /** @brief Gamepad button labels */ enum class GamepadType : std::uint8_t { Xbox, PlayStation, diff --git a/Sources/Jazz2/RumbleDescription.h b/Sources/Jazz2/RumbleDescription.h index 533bb85d..0124e506 100644 --- a/Sources/Jazz2/RumbleDescription.h +++ b/Sources/Jazz2/RumbleDescription.h @@ -22,6 +22,8 @@ namespace Jazz2 } private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct TimelineItem { float EndTime; @@ -35,6 +37,7 @@ namespace Jazz2 { } }; +#endif SmallVector _timeline; }; diff --git a/Sources/Jazz2/RumbleProcessor.h b/Sources/Jazz2/RumbleProcessor.h index 942eba4b..26af832f 100644 --- a/Sources/Jazz2/RumbleProcessor.h +++ b/Sources/Jazz2/RumbleProcessor.h @@ -18,6 +18,8 @@ namespace Jazz2 void OnEndFrame(float timeMult); private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct ActiveRumble { std::shared_ptr Desc; @@ -26,6 +28,7 @@ namespace Jazz2 ActiveRumble(std::int32_t joyId, std::shared_ptr desc); }; +#endif SmallVector _activeRumble; }; diff --git a/Sources/Jazz2/Tiles/TileMap.h b/Sources/Jazz2/Tiles/TileMap.h index 68bef747..2533ff37 100644 --- a/Sources/Jazz2/Tiles/TileMap.h +++ b/Sources/Jazz2/Tiles/TileMap.h @@ -215,6 +215,8 @@ namespace Jazz2::Tiles Sprite }; +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct TileSetPart { std::unique_ptr Data; std::int32_t Offset; @@ -243,6 +245,7 @@ namespace Jazz2::Tiles SmallVector, 0> _renderCommands; bool _alreadyRendered; }; +#endif ITileMapOwner* _owner; std::int32_t _sprLayerIndex; diff --git a/Sources/Jazz2/UI/Cinematics.h b/Sources/Jazz2/UI/Cinematics.h index 511d66c6..a78eca7f 100644 --- a/Sources/Jazz2/UI/Cinematics.h +++ b/Sources/Jazz2/UI/Cinematics.h @@ -41,6 +41,8 @@ namespace Jazz2::UI void OnTouchEvent(const TouchEvent& event) override; private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't class CinematicsCanvas : public SceneNode { public: @@ -58,6 +60,7 @@ namespace Jazz2::UI Cinematics* _owner; RenderCommand _renderCommand; }; +#endif #if defined(WITH_AUDIO) struct SfxItem { diff --git a/Sources/Jazz2/UI/FormattedTextBlock.h b/Sources/Jazz2/UI/FormattedTextBlock.h index 48f59d46..844bc6d7 100644 --- a/Sources/Jazz2/UI/FormattedTextBlock.h +++ b/Sources/Jazz2/UI/FormattedTextBlock.h @@ -109,6 +109,8 @@ namespace Jazz2::UI } private: +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct Part { const char* Value; @@ -135,6 +137,7 @@ namespace Jazz2::UI BackgroundPart(Colorf color); }; +#endif enum class FormattedTextBlockFlags : std::uint16_t { None = 0, diff --git a/Sources/Jazz2/UI/HUD.h b/Sources/Jazz2/UI/HUD.h index 00c73be3..2d476790 100644 --- a/Sources/Jazz2/UI/HUD.h +++ b/Sources/Jazz2/UI/HUD.h @@ -59,6 +59,8 @@ namespace Jazz2::UI WaitingForFadeOut }; +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct TouchButtonInfo { PlayerActions Action; @@ -94,6 +96,7 @@ namespace Jazz2::UI WeaponWheelState(); }; +#endif static constexpr std::uint32_t VertexBytes = sizeof(Vertex); static constexpr std::uint32_t VertexFloats = VertexBytes / sizeof(float); diff --git a/Sources/Jazz2/UI/LoadingHandler.h b/Sources/Jazz2/UI/LoadingHandler.h index 7a5a9fc7..b5a3bf64 100644 --- a/Sources/Jazz2/UI/LoadingHandler.h +++ b/Sources/Jazz2/UI/LoadingHandler.h @@ -27,6 +27,8 @@ namespace Jazz2::UI private: IRootController* _root; +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't class BackgroundCanvas : public Canvas { public: @@ -37,6 +39,7 @@ namespace Jazz2::UI private: LoadingHandler* _owner; }; +#endif UI::UpscaleRenderPass _upscalePass; std::unique_ptr _canvasBackground; diff --git a/Sources/Shared/Base/TypeInfo.h b/Sources/Shared/Base/TypeInfo.h index 01d7048c..3c7638b1 100644 --- a/Sources/Shared/Base/TypeInfo.h +++ b/Sources/Shared/Base/TypeInfo.h @@ -160,7 +160,6 @@ namespace Death { namespace TypeInfo { namespace Implementation { } }}} -#ifndef DOXYGEN_GENERATING_OUTPUT // It is located in the root namespace to keep the resulting string as short as possible template struct __ti @@ -181,7 +180,6 @@ struct __ti #endif } }; -#endif namespace Death { namespace TypeInfo { namespace Implementation { //###==##====#=====--==~--~=~- --- -- - - - - @@ -249,7 +247,7 @@ namespace Death { namespace TypeInfo { namespace Implementation { }; }}} -/** @brief Class annotation to enable optimized @ref runtime_cast(U*) functionality */ +/** @brief Class annotation to enable optimized `runtime_cast()` functionality */ #define DEATH_RUNTIME_OBJECT(...) \ __DEATH_WARNING_PUSH \ __DEATH_NO_OVERRIDE_WARNING \ @@ -291,7 +289,7 @@ DEATH_ALWAYS_INLINE T runtime_cast(const std::unique_ptr& u) noexcept { #else -/** @brief Class annotation to enable optimized @ref runtime_cast(U*) functionality */ +/** @brief Class annotation to enable optimized `runtime_cast()` functionality */ #define DEATH_RUNTIME_OBJECT(...) /** @brief Safely converts pointers to classes up, down, and sideways along the inheritance hierarchy of classes annotated by `DEATH_RUNTIME_OBJECT()` */ diff --git a/Sources/Shared/Containers/Array.h b/Sources/Shared/Containers/Array.h index 7f620ba4..271cf967 100644 --- a/Sources/Shared/Containers/Array.h +++ b/Sources/Shared/Containers/Array.h @@ -288,28 +288,21 @@ namespace Death { namespace Containers { * * If set to @cpp nullptr @ce, the contents are deleted using standard * @cpp operator delete[] @ce. - * @see @ref Array(T*, std::size_t, D) */ D deleter() const { return _deleter; } /** * @brief Array size - * - * @see @ref isEmpty() */ std::size_t size() const { return _size; } /** * @brief Whether the array is empty - * - * @see @ref size() */ bool empty() const { return !_size; } /** * @brief Pointer to first element - * - * @see @ref front(), @ref operator[]() */ T* begin() { return _data; } const T* begin() const { return _data; } /**< @overload */ @@ -317,8 +310,6 @@ namespace Death { namespace Containers { /** * @brief Pointer to (one item after) last element - * - * @see @ref back(), @ref operator[]() */ T* end() { return _data+_size; } const T* end() const { return _data+_size; } /**< @overload */ @@ -328,7 +319,6 @@ namespace Death { namespace Containers { * @brief First element * * Expects there is at least one element. - * @see @ref begin(), @ref operator[]() */ T& front(); const T& front() const; /**< @overload */ @@ -337,7 +327,6 @@ namespace Death { namespace Containers { * @brief Last element * * Expects there is at least one element. - * @see @ref end(), @ref operator[]() */ T& back(); const T& back() const; /**< @overload */ diff --git a/Sources/Shared/Containers/ArrayView.h b/Sources/Shared/Containers/ArrayView.h index 245cfd01..c9e87ce6 100644 --- a/Sources/Shared/Containers/ArrayView.h +++ b/Sources/Shared/Containers/ArrayView.h @@ -77,8 +77,6 @@ namespace Death { namespace Containers { * @brief Construct a view on an array with explicit size * @param data Data pointer * @param size Data size - * - * @see @ref arrayView(T*, std::size_t) */ constexpr /*implicit*/ ArrayView(T* data, std::size_t size) noexcept : _data(data), _size(size) {} @@ -731,8 +729,6 @@ namespace Death { namespace Containers { /** * @brief Pointer to the first element - * - * @see @ref front(), @ref operator[]() */ constexpr T* begin() const { return _data; } /** @overload */ @@ -761,7 +757,6 @@ namespace Death { namespace Containers { * @brief Element access * * Expects that @p i is less than @ref size(). - * @see @ref front(), @ref back() */ #ifdef DOXYGEN_GENERATING_OUTPUT constexpr T& operator[](std::size_t i) const; diff --git a/Sources/Shared/Containers/Function.h b/Sources/Shared/Containers/Function.h index 28cad717..778cb1e5 100644 --- a/Sources/Shared/Containers/Function.h +++ b/Sources/Shared/Containers/Function.h @@ -129,6 +129,8 @@ namespace Death { namespace Containers { private: template friend class Function; +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't union Storage { // Simple, small enough and trivial functors char data[Implementation::FunctionPointerSize*sizeof(std::size_t) + sizeof(void*)]; @@ -150,6 +152,7 @@ namespace Death { namespace Containers { void(*call)(); } functor; }; +#endif constexpr explicit FunctionData(const Storage& storage, void(*call)()): // GCC 4.8 attempts to initialize the first member (the char array) instead of performing a copy if {} is used diff --git a/Sources/Shared/Containers/String.h b/Sources/Shared/Containers/String.h index 2da96f1a..0b0fc023 100644 --- a/Sources/Shared/Containers/String.h +++ b/Sources/Shared/Containers/String.h @@ -1005,6 +1005,8 @@ namespace Death { namespace Containers { The above approach is consistent with StringView, which is the preferrable solution after all. */ +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct Small { #if defined(DEATH_TARGET_BIG_ENDIAN) unsigned char size; @@ -1029,6 +1031,7 @@ namespace Death { namespace Containers { Small _small; Large _large; }; +#endif }; }} \ No newline at end of file diff --git a/Sources/Shared/Containers/StringView.h b/Sources/Shared/Containers/StringView.h index f6ce5d9f..c892d554 100644 --- a/Sources/Shared/Containers/StringView.h +++ b/Sources/Shared/Containers/StringView.h @@ -783,7 +783,6 @@ namespace Death { namespace Containers { * * If it's only needed to know whether a character is contained in a * string at all, consider using @ref contains(char) const instead. - * @see @ref find(char) const */ std::size_t count(char character) const; diff --git a/Sources/Shared/IO/FileSystem.h b/Sources/Shared/IO/FileSystem.h index 2e0070f4..e21aa282 100644 --- a/Sources/Shared/IO/FileSystem.h +++ b/Sources/Shared/IO/FileSystem.h @@ -71,7 +71,7 @@ namespace Death { namespace IO { DEFINE_PRIVATE_ENUM_OPERATORS(EnumerationOptions); - /** @brief The class that handles directory traversal, should be used as iterator */ + /** @brief Handles directory traversal, should be used as iterator */ class Directory { public: diff --git a/Sources/Shared/IO/PakFile.h b/Sources/Shared/IO/PakFile.h index af5ede75..a5db3c27 100644 --- a/Sources/Shared/IO/PakFile.h +++ b/Sources/Shared/IO/PakFile.h @@ -41,7 +41,7 @@ namespace Death { namespace IO { std::unique_ptr OpenFile(Containers::StringView path); - /** @brief The class that handles directory traversal, should be used as iterator */ + /** @brief Handles directory traversal, should be used as iterator */ class Directory { public: @@ -114,6 +114,8 @@ namespace Death { namespace IO { DEFINE_PRIVATE_ENUM_OPERATORS(ItemFlags); +#ifndef DOXYGEN_GENERATING_OUTPUT + // Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't struct Item { Containers::String Name; ItemFlags Flags; @@ -123,6 +125,7 @@ namespace Death { namespace IO { Containers::Array ChildItems; }; +#endif static constexpr std::uint64_t Signature = 0x208FA69FF0BFBBEF; static constexpr std::uint16_t Version = 1; diff --git a/Sources/Shared/Threading/Event.h b/Sources/Shared/Threading/Event.h index 97e84ade..f749f323 100644 --- a/Sources/Shared/Threading/Event.h +++ b/Sources/Shared/Threading/Event.h @@ -57,7 +57,7 @@ namespace Death { namespace Threading { Event& operator=(const Event&) = delete; Event& operator=(Event&&) = delete; - // Returns the previous state of the event + /** @brief Sets the state of the event to nonsignaled, causing threads to block, returns the previous state of the event */ bool ResetEvent() noexcept { bool result; @@ -79,6 +79,7 @@ namespace Death { namespace Threading { return result; } + /** @brief Sets the state of the event to signaled, allowing one or more waiting threads to proceed */ void SetEvent() noexcept { if DEATH_LIKELY(Implementation::IsWaitOnAddressSupported()) { @@ -108,13 +109,13 @@ namespace Death { namespace Threading { } } - // Checks if the event is currently signaled - // Note: Unlike Win32 auto-reset event objects, this will not reset the event + /** @brief Checks if the event is currently signaled, this will not reset the event (unlike Win32 auto-reset event objects) */ bool IsSignaled() const noexcept { return !!_isSignaled.load(std::memory_order_acquire); } + /** @brief Blocks the current thread until the event receives a signal */ bool Wait(std::uint32_t timeoutMilliseconds) noexcept { if (timeoutMilliseconds == 0) { @@ -143,6 +144,7 @@ namespace Death { namespace Threading { return true; } + /** @overload */ bool Wait() noexcept { while (!TryAcquireEvent()) { @@ -216,10 +218,10 @@ namespace Death { namespace Threading { #endif }; - /** @brief An event object that will atomically revert to an unsignaled state anytime a @cpp Wait() @ce call succeeds (i.e. returns true). */ + /** @brief An event object that will atomically revert to an unsignaled state anytime a @relativeref{Event,Wait} call succeeds (i.e., returns true). */ using AutoResetEvent = Event; - /** @brief An event object that once signaled remains that way forever, unless @cpp ResetEvent() @ce is called. */ + /** @brief An event object that once signaled remains that way forever, unless @relativeref{Event,ResetEvent} is called. */ using ManualResetEvent = Event; }} \ No newline at end of file diff --git a/Sources/nCine/AppConfiguration.h b/Sources/nCine/AppConfiguration.h index 00d15fa3..c6b7151b 100644 --- a/Sources/nCine/AppConfiguration.h +++ b/Sources/nCine/AppConfiguration.h @@ -9,7 +9,7 @@ using namespace Death::Containers; namespace nCine { - /// The class storing initialization settings for an nCine application + /// Stores initialization settings for an nCine application class AppConfiguration { public: diff --git a/Sources/nCine/Audio/ALAudioDevice.h b/Sources/nCine/Audio/ALAudioDevice.h index 8acd51e4..244fca6b 100644 --- a/Sources/nCine/Audio/ALAudioDevice.h +++ b/Sources/nCine/Audio/ALAudioDevice.h @@ -18,7 +18,7 @@ using namespace Death::Containers; namespace nCine { - /// It represents the interface to the OpenAL audio device + /// OpenAL audio device backend implementation class ALAudioDevice : public IAudioDevice #if defined(DEATH_TARGET_WINDOWS) && !defined(DEATH_TARGET_WINDOWS_RT) , public IMMNotificationClient diff --git a/Sources/nCine/Audio/AudioBuffer.h b/Sources/nCine/Audio/AudioBuffer.h index 3d727865..3db04cc8 100644 --- a/Sources/nCine/Audio/AudioBuffer.h +++ b/Sources/nCine/Audio/AudioBuffer.h @@ -11,7 +11,7 @@ namespace nCine { class IAudioLoader; - /// A class representing an OpenAL buffer + /// OpenAL audio buffer /*! It inherits from `Object` because a buffer can be * shared by more than one `AudioBufferPlayer` object. */ class AudioBuffer : public Object diff --git a/Sources/nCine/Audio/AudioLoaderOgg.h b/Sources/nCine/Audio/AudioLoaderOgg.h index cc18fdc9..a9169629 100644 --- a/Sources/nCine/Audio/AudioLoaderOgg.h +++ b/Sources/nCine/Audio/AudioLoaderOgg.h @@ -8,7 +8,7 @@ namespace nCine { - /// Ogg Vorbis audio loader + /// Ogg Vorbis audio loader using `libvorbis` library class AudioLoaderOgg : public IAudioLoader { public: diff --git a/Sources/nCine/Audio/AudioReaderOgg.h b/Sources/nCine/Audio/AudioReaderOgg.h index d5fdd89b..c3ddfd2b 100644 --- a/Sources/nCine/Audio/AudioReaderOgg.h +++ b/Sources/nCine/Audio/AudioReaderOgg.h @@ -21,7 +21,7 @@ namespace nCine { class AudioLoaderOgg; - /// Ogg Vorbis audio reader + /// Ogg Vorbis audio reader using `libvorbis` library class AudioReaderOgg : public IAudioReader { friend class AudioLoaderOgg; diff --git a/Sources/nCine/Audio/AudioStream.h b/Sources/nCine/Audio/AudioStream.h index ee6d2e85..c7a46455 100644 --- a/Sources/nCine/Audio/AudioStream.h +++ b/Sources/nCine/Audio/AudioStream.h @@ -12,7 +12,7 @@ namespace nCine class IAudioReader; class IAudioLoader; - /// Audio stream + /// OpenAL audio stream class AudioStream { public: diff --git a/Sources/nCine/Audio/IAudioDevice.h b/Sources/nCine/Audio/IAudioDevice.h index a6d3aa49..0d7648e5 100644 --- a/Sources/nCine/Audio/IAudioDevice.h +++ b/Sources/nCine/Audio/IAudioDevice.h @@ -7,7 +7,7 @@ namespace nCine { class IAudioPlayer; - /// Audio device interface class + /// Audio device interface class IAudioDevice { public: diff --git a/Sources/nCine/Audio/IAudioLoader.h b/Sources/nCine/Audio/IAudioLoader.h index 536309f4..87f12e67 100644 --- a/Sources/nCine/Audio/IAudioLoader.h +++ b/Sources/nCine/Audio/IAudioLoader.h @@ -9,7 +9,7 @@ namespace nCine { - /// Audio loader interface class + /// Audio loader interface class IAudioLoader { public: diff --git a/Sources/nCine/Audio/IAudioPlayer.h b/Sources/nCine/Audio/IAudioPlayer.h index 0fa49f78..3f5f8f51 100644 --- a/Sources/nCine/Audio/IAudioPlayer.h +++ b/Sources/nCine/Audio/IAudioPlayer.h @@ -6,7 +6,7 @@ namespace nCine { - /// Audio player interface class + /// Audio player interface class IAudioPlayer : public Object { DEATH_RUNTIME_OBJECT(); diff --git a/Sources/nCine/Audio/IAudioReader.h b/Sources/nCine/Audio/IAudioReader.h index 0d73317d..8c9fb5f0 100644 --- a/Sources/nCine/Audio/IAudioReader.h +++ b/Sources/nCine/Audio/IAudioReader.h @@ -2,7 +2,7 @@ namespace nCine { - /// Audio reader interface class + /// Audio reader interface class IAudioReader { public: @@ -23,6 +23,7 @@ namespace nCine virtual void setLooping(bool value) { } }; + /// A class created when the audio file extension is not recognized. class InvalidAudioReader : IAudioReader { public: diff --git a/Sources/nCine/Base/Clock.h b/Sources/nCine/Base/Clock.h index 6bbdc007..c0ae2ff8 100644 --- a/Sources/nCine/Base/Clock.h +++ b/Sources/nCine/Base/Clock.h @@ -4,7 +4,7 @@ namespace nCine { - /// The class interfacing with the system clock + /// System clock class Clock { public: diff --git a/Sources/nCine/Base/HashFunctions.h b/Sources/nCine/Base/HashFunctions.h index e815a79a..8f62db95 100644 --- a/Sources/nCine/Base/HashFunctions.h +++ b/Sources/nCine/Base/HashFunctions.h @@ -62,10 +62,6 @@ namespace nCine }; #ifndef DOXYGEN_GENERATING_OUTPUT - /// Shift-Add-XOR hash function - /*! - * \note Specialized version of the function for C-style strings - */ template<> class SaxHashFunc { @@ -81,10 +77,6 @@ namespace nCine } }; - /// Shift-Add-XOR hash function - /*! - * \note Specialized version of the function for String objects - */ template<> class SaxHashFunc { @@ -127,12 +119,6 @@ namespace nCine }; #ifndef DOXYGEN_GENERATING_OUTPUT - /// Jenkins hash function - /*! - * \note Specialized version of the function for C-style strings - * - * For more information: http://en.wikipedia.org/wiki/Jenkins_hash_function - */ template<> class JenkinsHashFunc { @@ -154,12 +140,6 @@ namespace nCine } }; - /// Jenkins hash function - /*! - * \note Specialized version of the function for String objects - * - * For more information: http://en.wikipedia.org/wiki/Jenkins_hash_function - */ template<> class JenkinsHashFunc { @@ -211,11 +191,6 @@ namespace nCine }; #ifndef DOXYGEN_GENERATING_OUTPUT - /*! - * \note Specialized version of the function for C-style strings - * - * For more information: http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function - */ template<> class FNV1aHashFunc { @@ -240,12 +215,6 @@ namespace nCine } }; - /// Fowler-Noll-Vo Hash (FNV-1a) - /*! - * \note Specialized version of the function for String objects - * - * For more information: http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function - */ template<> class FNV1aHashFunc { @@ -284,7 +253,7 @@ namespace nCine uint64_t fasthash64(const void* buf, size_t len, uint64_t seed); uint32_t fasthash32(const void* buf, size_t len, uint32_t seed); - /// fast-hash + /// Fast-hash /*! * For more information: https://github.com/ztanml/fast-hash */ @@ -305,7 +274,6 @@ namespace nCine }; #ifndef DOXYGEN_GENERATING_OUTPUT - /// fast-hash /*! * \note Specialized version of the function for C-style strings * @@ -324,7 +292,6 @@ namespace nCine static const uint32_t Seed = 0x811C9DC5; }; - /// fast-hash /*! * \note Specialized version of the function for String objects * diff --git a/Sources/nCine/Base/StaticHashMapIterator.h b/Sources/nCine/Base/StaticHashMapIterator.h index 714ce687..07905680 100644 --- a/Sources/nCine/Base/StaticHashMapIterator.h +++ b/Sources/nCine/Base/StaticHashMapIterator.h @@ -26,7 +26,7 @@ namespace nCine using NodeReference = const typename StaticHashMap::Node&; }; - /// A hashmap iterator + /// Static hashmap iterator template class StaticHashMapIterator { diff --git a/Sources/nCine/Graphics/AnimatedSprite.h b/Sources/nCine/Graphics/AnimatedSprite.h index d3649704..78a31773 100644 --- a/Sources/nCine/Graphics/AnimatedSprite.h +++ b/Sources/nCine/Graphics/AnimatedSprite.h @@ -9,7 +9,7 @@ using namespace Death::Containers; namespace nCine { - /// A class for an animated sprite + /// Animated sprite class AnimatedSprite : public Sprite { public: diff --git a/Sources/nCine/Graphics/BaseSprite.h b/Sources/nCine/Graphics/BaseSprite.h index 0d3ef471..42749f73 100644 --- a/Sources/nCine/Graphics/BaseSprite.h +++ b/Sources/nCine/Graphics/BaseSprite.h @@ -8,7 +8,7 @@ namespace nCine class Texture; class GLUniformBlockCache; - /// The base class for sprites + /// Base class for sprites /*! \note Users cannot create instances of this class */ class BaseSprite : public DrawableNode { diff --git a/Sources/nCine/Graphics/BinaryShaderCache.h b/Sources/nCine/Graphics/BinaryShaderCache.h index 38d8214f..c964c939 100644 --- a/Sources/nCine/Graphics/BinaryShaderCache.h +++ b/Sources/nCine/Graphics/BinaryShaderCache.h @@ -15,7 +15,7 @@ using namespace Death::Containers; namespace nCine { - /// The class that manages the cache of binary OpenGL shader programs + /// Manages the cache of binary OpenGL shader programs class BinaryShaderCache { public: diff --git a/Sources/nCine/Graphics/DrawableNode.h b/Sources/nCine/Graphics/DrawableNode.h index 7c0445e1..c69ad874 100644 --- a/Sources/nCine/Graphics/DrawableNode.h +++ b/Sources/nCine/Graphics/DrawableNode.h @@ -9,7 +9,7 @@ namespace nCine class RenderCommand; class RenderQueue; - /// A class for objects that can be drawn through the render queue + /// Object that can be drawn through the render queue class DrawableNode : public SceneNode { public: diff --git a/Sources/nCine/Graphics/Geometry.h b/Sources/nCine/Graphics/Geometry.h index 7c760fab..7a48200f 100644 --- a/Sources/nCine/Graphics/Geometry.h +++ b/Sources/nCine/Graphics/Geometry.h @@ -7,7 +7,7 @@ namespace nCine { - /// The class containing geometric data for a drawable node + /// Contains geometric data for a drawable node class Geometry { public: diff --git a/Sources/nCine/Graphics/GfxCapabilities.h b/Sources/nCine/Graphics/GfxCapabilities.h index 7d086f04..595acfbd 100644 --- a/Sources/nCine/Graphics/GfxCapabilities.h +++ b/Sources/nCine/Graphics/GfxCapabilities.h @@ -4,7 +4,7 @@ namespace nCine { - /// A class that stores and retrieves runtime OpenGL device capabilities + /// Stores and retrieves runtime OpenGL device capabilities class GfxCapabilities : public IGfxCapabilities { public: diff --git a/Sources/nCine/Graphics/IGfxCapabilities.h b/Sources/nCine/Graphics/IGfxCapabilities.h index 7fe8a034..05dddc51 100644 --- a/Sources/nCine/Graphics/IGfxCapabilities.h +++ b/Sources/nCine/Graphics/IGfxCapabilities.h @@ -4,7 +4,7 @@ namespace nCine { - /// The interface class to query runtime OpenGL device capabilities + /// Interface to query runtime OpenGL device capabilities class IGfxCapabilities { public: diff --git a/Sources/nCine/Graphics/IGfxDevice.h b/Sources/nCine/Graphics/IGfxDevice.h index 94a84600..38ee8ca8 100644 --- a/Sources/nCine/Graphics/IGfxDevice.h +++ b/Sources/nCine/Graphics/IGfxDevice.h @@ -20,7 +20,7 @@ namespace nCine { class Colorf; - /// It represents the interface to the graphics device where everything is rendered + /// Represents the interface to the graphics device where everything is rendered class IGfxDevice { public: diff --git a/Sources/nCine/Graphics/RectAnimation.h b/Sources/nCine/Graphics/RectAnimation.h index 7bc31fe1..46433e42 100644 --- a/Sources/nCine/Graphics/RectAnimation.h +++ b/Sources/nCine/Graphics/RectAnimation.h @@ -8,7 +8,7 @@ using namespace Death::Containers; namespace nCine { - /// The class containing data for a rectangles based animation + /// Contains data for a rectangles based animation class RectAnimation { public: diff --git a/Sources/nCine/Graphics/RenderBatcher.h b/Sources/nCine/Graphics/RenderBatcher.h index d2added1..a94ce53b 100644 --- a/Sources/nCine/Graphics/RenderBatcher.h +++ b/Sources/nCine/Graphics/RenderBatcher.h @@ -10,7 +10,7 @@ namespace nCine { class RenderCommand; - /// A class that batches render commands together + /// Batches render commands together class RenderBatcher { public: diff --git a/Sources/nCine/Graphics/RenderBuffersManager.h b/Sources/nCine/Graphics/RenderBuffersManager.h index 6ceaaec0..c2e48c2e 100644 --- a/Sources/nCine/Graphics/RenderBuffersManager.h +++ b/Sources/nCine/Graphics/RenderBuffersManager.h @@ -10,7 +10,7 @@ using namespace Death::Containers; namespace nCine { - /// The class handling the memory mapping in multiple OpenGL Buffer Objects + /// Handles the memory mapping in multiple OpenGL Buffer Objects class RenderBuffersManager { public: diff --git a/Sources/nCine/Graphics/RenderCommand.h b/Sources/nCine/Graphics/RenderCommand.h index 8ffa1637..f56731fa 100644 --- a/Sources/nCine/Graphics/RenderCommand.h +++ b/Sources/nCine/Graphics/RenderCommand.h @@ -9,7 +9,7 @@ namespace nCine { class Color; - /// The class wrapping all the information needed for issuing a draw command + /// Wraps all the information needed for issuing a draw command class RenderCommand { public: diff --git a/Sources/nCine/Graphics/RenderCommandPool.h b/Sources/nCine/Graphics/RenderCommandPool.h index dcfc7b45..0da01af2 100644 --- a/Sources/nCine/Graphics/RenderCommandPool.h +++ b/Sources/nCine/Graphics/RenderCommandPool.h @@ -12,7 +12,7 @@ namespace nCine { class RenderCommand; - /// The class that creates and handles the pool of render commands + /// Creates and handles the pool of render commands class RenderCommandPool { public: diff --git a/Sources/nCine/Graphics/RenderQueue.h b/Sources/nCine/Graphics/RenderQueue.h index 1ce247a1..c1060f6c 100644 --- a/Sources/nCine/Graphics/RenderQueue.h +++ b/Sources/nCine/Graphics/RenderQueue.h @@ -8,7 +8,7 @@ using namespace Death::Containers; namespace nCine { - /// A class that sorts and issues the render commands collected by the scenegraph visit + /// Sorts and issues the render commands collected by the scenegraph visit class RenderQueue { public: diff --git a/Sources/nCine/Graphics/RenderResources.h b/Sources/nCine/Graphics/RenderResources.h index 7771230b..7864dd76 100644 --- a/Sources/nCine/Graphics/RenderResources.h +++ b/Sources/nCine/Graphics/RenderResources.h @@ -21,7 +21,7 @@ namespace nCine class Camera; class Viewport; - /// The class that creates and handles application common OpenGL rendering resources + /// Creates and handles application common OpenGL rendering resources class RenderResources { /// The `Application` class needs to create and dispose the resources diff --git a/Sources/nCine/Graphics/RenderStatistics.h b/Sources/nCine/Graphics/RenderStatistics.h index c17befa6..08b44be5 100644 --- a/Sources/nCine/Graphics/RenderStatistics.h +++ b/Sources/nCine/Graphics/RenderStatistics.h @@ -6,7 +6,7 @@ namespace nCine { - /// A class to gather statistics about the rendering subsystem + /// Gathers statistics about the rendering subsystem class RenderStatistics { public: diff --git a/Sources/nCine/Graphics/RenderVaoPool.h b/Sources/nCine/Graphics/RenderVaoPool.h index 8a174c04..36f4b04d 100644 --- a/Sources/nCine/Graphics/RenderVaoPool.h +++ b/Sources/nCine/Graphics/RenderVaoPool.h @@ -14,7 +14,7 @@ namespace nCine { class GLVertexArrayObject; - /// The class that creates and handles the pool of VAOs + /// Creates and handles the pool of VAOs class RenderVaoPool { public: diff --git a/Sources/nCine/Graphics/ScreenViewport.h b/Sources/nCine/Graphics/ScreenViewport.h index b3710dea..df4f9feb 100644 --- a/Sources/nCine/Graphics/ScreenViewport.h +++ b/Sources/nCine/Graphics/ScreenViewport.h @@ -4,7 +4,7 @@ namespace nCine { - /// The class handling the screen viewport + /// Handles the screen viewport class ScreenViewport : public Viewport { public: diff --git a/Sources/nCine/Graphics/Sprite.h b/Sources/nCine/Graphics/Sprite.h index 320038f0..86b8ac44 100644 --- a/Sources/nCine/Graphics/Sprite.h +++ b/Sources/nCine/Graphics/Sprite.h @@ -4,7 +4,7 @@ namespace nCine { - /// A scene node representing a regular sprite + /// Scene node representing a regular sprite class Sprite : public BaseSprite { public: diff --git a/Sources/nCine/Graphics/TextureLoaderRaw.h b/Sources/nCine/Graphics/TextureLoaderRaw.h index 277c06d7..0507f02e 100644 --- a/Sources/nCine/Graphics/TextureLoaderRaw.h +++ b/Sources/nCine/Graphics/TextureLoaderRaw.h @@ -4,7 +4,7 @@ namespace nCine { - /// A texture loader used to specify a raw format when loading texels + /// Texture loader used to specify a raw format when loading texels class TextureLoaderRaw : public ITextureLoader { public: diff --git a/Sources/nCine/Graphics/Viewport.h b/Sources/nCine/Graphics/Viewport.h index e0009f69..b1ab85a4 100644 --- a/Sources/nCine/Graphics/Viewport.h +++ b/Sources/nCine/Graphics/Viewport.h @@ -19,7 +19,7 @@ namespace nCine class GLFramebuffer; class Texture; - /// The class handling a viewport and its corresponding render target texture + /// Handles a viewport and its corresponding render target texture class Viewport { public: diff --git a/Sources/nCine/Input/IInputEventHandler.h b/Sources/nCine/Input/IInputEventHandler.h index 11f7b475..57bafe07 100644 --- a/Sources/nCine/Input/IInputEventHandler.h +++ b/Sources/nCine/Input/IInputEventHandler.h @@ -4,7 +4,7 @@ namespace nCine { - /// The interface class for handling input events from keyboard, screen touches, mouse, accelerometer and joystick + /// Interface for handling input events from keyboard, screen touches, mouse, accelerometer and joystick class IInputEventHandler { public: diff --git a/Sources/nCine/Input/IInputManager.h b/Sources/nCine/Input/IInputManager.h index 89587ed4..c2f28214 100644 --- a/Sources/nCine/Input/IInputManager.h +++ b/Sources/nCine/Input/IInputManager.h @@ -40,7 +40,7 @@ namespace nCine std::uint8_t data[16]; }; - /// The interface class for parsing and dispatching input events + /// Interface for parsing and dispatching input events class IInputManager { public: