DocUtils.h#

Fully qualified name: carb/DocUtils.h
// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.

#pragma once

#ifdef DOXYGEN_BUILD
#    define CARB_DOC_ONLY(...) __VA_ARGS__

#    define CARB_NO_DOC(...)

#    define CARB_DOC_CONSTEXPR const

// clang-format off
#    define DOXYGEN_EMPTY_CLASS {}
// clang-format on

// Doxygen apparently does not like noexcept in some situations
#    define CARB_NOEXCEPT throw()
#else
#    define CARB_DOC_CONSTEXPR constexpr
#    define CARB_DOC_ONLY(...)
#    define CARB_NO_DOC(...) __VA_ARGS__
#    define DOXYGEN_EMPTY_CLASS
#    define CARB_NOEXCEPT noexcept
#endif