我已经开始使用Doxygen(预编译为1.8.14)为Windows 10上的C ++项目生成简单的代码文档。
在头文件中,我定义了三个模板化函数,并将我的定义放在头文件末尾包含的.tpp文件中。查看生成的输出,似乎doxygen无法读取此文件。 因此,我得出结论说强氧不支持这一点。
但是,根据手册(http://www.doxygen.nl/manual/starting.html),它说:“任何其他扩展名都被解析为C / C ++文件。”确实没有实现这种功能吗?
IPC.hpp(示例)
class IPC {
public:
template <class T, int N>
bool setData(std::vector<T> data, Offsets offset);
template <class T, int N>
std::array<T, N> getData(Offsets offset);
template <class T, int N>
bool getData(std::array<T, N> &data, Offsets offset);
bool getTrigger(Offsets selector, long timeout_ms = 0);
void setTrigger(Offsets selector, Status on);
};
#include "IPC.tpp"
IPC.tpp(示例)
#pragma once
/*! Writes to the shared memory object.
\param data gives the data that will be written.
\param offset gives the byte offset from the start of the file.
\return bool: true on completion
\sa getData()
*/
template <class T, int N>
bool IPC::setData(std::vector<T> data, Offsets offset) {
//Calculate the memory block size from the type and number
unsigned int block_size = sizeof(T) * N;
//Safety check
if (block_size + offset > _size) {
std::cerr << "Error at IPC::setData(): Block size is bigger than memory block size" << std::endl;
return false;
}
if (data.size() < N) {
std::cerr << "Error at IPC::setData(): Data array is smaller than N" << std::endl;
return false;
}
//Create mapped_region
mapped_region region(_shm, read_write, offset, block_size);
for (int i = 0; i < N; i++) {
std::memcpy((char* ) region.get_address() + sizeof(T) * i, &(data.at(i)), sizeof(T));
}
return true;
}
答案 0 :(得分:0)
供以后参考:将tpp=C++
添加到EXTENSION_MAPPING
(在doxywizard中的expert/project
下),将*.tpp
添加到FILE_PATTERNS
(在doxywizard中的expert/input
下) )。