将静态变量的初始值的 doxygen 复制到 \file 块

发布于 2024-11-04 19:33:23 字数 531 浏览 3 评论 0原文

我试图将静态变量的初始值的 doxygen 复制到 \file 块中代码的顶部。也就是说，在这样的情况下：

#include <iostream>

/*! \file Test.cxx
 * This is my program.
 * \copydetails HelpText
 */

/*! \var
 * This is my static string.
 */
static std::string HelpText = "Calculate the average magnitude of the vectors in a vector image.\n\n\
    Usage:\n\
    -in InputVectorImageFileName\n";

int main()
{

  return 0;
}

我希望“用法”字符串出现在主文件文档中。正如您所看到的，我尝试了 \copydoc 但它似乎只复制静态变量上方的注释，而不是初始值。请注意，初始值正确显示在变量的文档中。

有什么建议吗？

谢谢。

原文

I am trying to copy the doxygen of the initial value of a static variable to the top of my code in the \file block. That is, in something like this:

#include <iostream>

/*! \file Test.cxx
 * This is my program.
 * \copydetails HelpText
 */

/*! \var
 * This is my static string.
 */
static std::string HelpText = "Calculate the average magnitude of the vectors in a vector image.\n\n\
    Usage:\n\
    -in InputVectorImageFileName\n";

int main()
{

  return 0;
}

I would want the "Usage" string to appear in the main file documentation. As you can see I tried \copydoc but it only seems to copy the comment above the static variable, not the initial value. Note that the initial value appears properly in the variable's documentation.

Any suggestions?

Thanks.

分享到QQ

分享到微博