Program Listing for example/ExampleDoxygen.h

↰ Return to documentation for example/ExampleDoxygen.h

// Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
//
// NVIDIA CORPORATION and its licensors retain all intellectual property
// and proprietary rights in and to this software, related documentation
// and any modifications thereto. Any use, reproduction, disclosure or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA CORPORATION is strictly prohibited.
//

#pragma once

#include "../../../include/carb/Defines.h"

namespace example
{

class ExampleDoxygen
{
public:
    float* exampleMethod(const char* name, int x, int y, int z);

    void advancedExampleMethod();

    // Functions that are public but you want to specifically leave undocumented can be made private with \@private.
    void internalOnlyFunction();

protected:
    void myProtectedFunction();

private:
    // Implementation details, like private data, are not included in the Doxygen output.
    int _myPrivateData;
};

// There are times when Doxygen should either not document an entity or is unable to do so (e.g. Doxygen's support for
// template specialization is poor).  In these cases, use the DOXYGEN_BUILD preprocessor symbol.
#ifndef DOXYGEN_BUILD
void myUndocumentedFunction();
#endif

struct OpaqueStruct;

} // namespace example