directPhaseReconstructorOrtho_test.cpp

Go to the documentation of this file.

/** \file directPhaseReconstructorOrtho_test.cpp
 * \brief Documentation-only ownership placeholder for the legacy directPhaseReconstructorOrtho header.
 */
#include "../../../catch2/catch.hpp"
 
#include "../../../../include/ao/sim/directPhaseReconstructorOrtho.hpp"
 
/** \defgroup directPhaseReconstructorOrtho_unit_tests directPhaseReconstructorOrtho Unit Tests
 * \ingroup ao_sim_unit_tests
 */
 
namespace unitTest::placeholder::ao_sim_directPhaseReconstructorOrtho_test
{
 
/** \brief Keeps ownership of the legacy directPhaseReconstructorOrtho header visible in the documented test inventory.
 *
 * The header declares a duplicate mx::AO::sim::directPhaseReconstructor class and this TEST_CASE is intentionally not
 * compiled.
 *
 * \ingroup directPhaseReconstructorOrtho_unit_tests
 * \todo Decide whether to remove or modernize the header before enabling compilation and behavioral tests for
 * mx::AO::sim::directPhaseReconstructor.
 */
TEST_CASE( "directPhaseReconstructorOrtho header has a documentation-only ownership placeholder",
           "[ao::sim::directPhaseReconstructorOrtho][placeholder]" )
{
    SUCCEED( "directPhaseReconstructorOrtho remains excluded pending removal or modernization." );
}
 
} // namespace unitTest::placeholder::ao_sim_directPhaseReconstructorOrtho_test