Когда я пишу шаблоны классов и нуждаюсь в полной специализации членов этих классов, Doxygen не распознает специализацию - он документирует только общее определение или (если есть только специализации) последнее определение. Вот простой пример:
=== MyClass.hpp ===
#ifndef MYCLASS_HPP
#define MYCLASS_HPP
template<class T> class MyClass{
public:
static void foo();
static const int INT_CONST;
static const T TTYPE_CONST;
};
/* generic definitions */
template<class T>
void MyClass<T>::foo(){
printf("Generic foo\n");
}
template<class T>
const int MyClass<T>::INT_CONST = 5;
/* specialization declarations */
template<> void MyClass<double>::foo();
template<> const int MyClass<double>::INT_CONST;
template<> const double MyClass<double>::TTYPE_CONST;
template<> const char MyClass<char>::TTYPE_CONST;
#endif
=== MyClass.cpp ===
#include "MyClass.hpp"
/* specialization definitions */
template<>
void MyClass<double>::foo(){
printf("Specialized double foo\n");
}
template<> const int MyClass<double>::INT_CONST = 10;
template<> const double MyClass<double>::TTYPE_CONST = 3.141;
template<> const char MyClass<char>::TTYPE_CONST = 'a';
Таким образом, в этом случае foo () будет задокументировано как вывод «Generic foo», INT_CONST будет задокументирован как установленный на 5, без упоминания специализаций, а TTYPE_CONST будет задокументирован как установленный на «a», с нет упоминания о 3.141 и нет указаний на то, что «а» является специализированным случаем.
Мне нужно иметь возможность задокументировать специализации - либо в документации для MyClass<T>, либо на новых страницах для MyClass<double>, MyClass<char>. Как мне это сделать? Может ли Doxygen с этим справиться? Возможно, я что-то не так делаю в структуре объявлений / кода, которая мешает Doxygen понять, чего я хочу?
Я должен отметить два связанных случая:
A) Для шаблонных функций хорошо работает специализация, например ::
/* functions that are global/in a namespace */
template<class T> void foo(){ printf("Generic foo\n"); }
template<> void foo<double>(){ printf("Specialized double foo\n"); }
Это будет документально foo<T>() и foo<double>().
B) Если я заново объявлю весь шаблон, то есть template<> class MyClass<double>{...};, тогда MyClass<double> получит свою собственную страницу документации в качестве отдельного класса. Но это фактически означает объявление совершенно нового класса - нет никакой связи между MyClass<T> и MyClass<double>, если объявлен сам MyClass<double>. Так что мне нужно было бы повторно объявить класс и все его члены, и , повторить все определения членов класса, специализированные для MyClass<double>, чтобы все выглядело так, как будто они используют один и тот же шаблон. Очень неловко, похоже на решение проблемы.
Предложения? Большое спасибо:)
- Зив