Doxygen сообщает "потенциальное рекурсивное отношение класса"
У меня есть шаблон С++ templated base::Foo<class T>
, и у меня есть в другом файле класс base::bar::Foo : public base::Foo<Baz>
. Doxygen, похоже, не нравится, так как это вызывает ошибку
<unknown>:1: Detected potential recursive class relation between class snLib::mocTwod::DsaCell and base class DsaCell< snLib::mocTwod::ProblemTraits, detLib::cellDiffusionTwod::ProblemTraits >!
Есть ли способ предотвратить это? Документация Doxygen не говорит об этой ошибке или о "возможных рекурсивных отношениях классов".
"базовый" класс:
/*! \file snlib/DsaCell.hpp
*/
#ifndef snlib_DsaCell_hpp
#define snlib_DsaCell_hpp
#include "Dsa.hpp"
namespace snLib {
/*!
* \brief Implementation of naive cell-centered DSA
*/
template <class HoTraits_T, class LoTraits_T>
class DsaCell : public snLib::Dsa< HoTraits_T, LoTraits_T >
{
[snip]
};
}
#endif
один из его потомков, который вызывает проблему:
/*! \file snlib/twod/moc/DsaCell.hpp
*/
#ifndef snlib_twod_moc_DsaCell_hpp
#define snlib_twod_moc_DsaCell_hpp
#include "snlib/DsaCell.hpp"
#include "ProblemTraits.hpp"
#include "detlib/twod/celldiffusion/ProblemTraits.hpp"
namespace snLib { namespace mocTwod {
/*!
* \brief Inconsistent DSA for MOC
*/
class DsaCell : public snLib::DsaCell<
snLib::mocTwod::ProblemTraits,
detLib::cellDiffusionTwod::ProblemTraits
>
{
[snip]
};
} } // end namespace snLib::mocTwod
#endif
В моем конфигурационном файле My Doxygen имеется множество опций, включая конфигурацию пути: STRIP_FROM_PATH
(устанавливается в корневой каталог), STRIP_FROM_INC_PATH
(тот же), INCLUDE_PATH
(тот же).
Изменить: похоже, что ошибка была фактически выбрана в другом Doxyfile, который использовал теги XML, сгенерированные с помощью конфликтующего имени, поэтому проблема была связана с этим. Во всяком случае, я просто переименовал базовый класс в нечто другое, и все было хорошо снова.
Ответы
Ответ 1
Doxygen имеет функцию, которая проверяет, имеют ли классы A и B отношение наследования
(прямой или косвенный), который является рекурсивным. Функция проверяет рекурсию для предельной глубины 256.
Вероятно, doxygen запутался с вашим кодом (с совпадением имени) и подумайте, что класс A зависит от B и B снова зависит от A.
Это может быть ошибка Doxygen, но лучший подход можно переименовать в класс.