doxygen docs中的多种语言(C ++)

时间:2017-10-10 08:32:11

标签: documentation doxygen multilingual

我的客户给了我不寻常的(并且不可协商的)要求,为他们提供来自C ++代码的双语(英语和波兰语)doxygen文档。

我的第一个想法是使用条件编译进行评论,例如:

#if DOXYGEN_ENGLISH
/**
 * @brief Sample method
 */
#elif DOXYGEN_POLISH
/**
 * @brief Przykładowa metoda
 */
#endif
void foo();

然后使用不同的基本语言环境和预定义的常量运行Doxygen两次......它实际上有效。但它非常麻烦......

有人知道如何改进此解决方案?或者以不同的方式解决它?

1 个答案:

答案 0 :(得分:3)

Doxygen具有用于处理不同语言的内置命令\〜[langId]。 上面提到的例子可以表述为:

/**
 * \~english @brief Sample method
 * \~polish @brief Przykladowa metoda
 */
void foo();
  • 没有直接要求使用预处理器/预处理器指令/设置
  • 切换语言时,doxygen配置文件中只有一个地方需要更改(Doxyfile)。