标签: doxygen

我有一些C++源代码,模板可能是这样的 - doxygen运行没有错误,但没有文档添加到输出,发生了什么？

///
/// A class
///
class A
{
  ///
  /// A typedef
  ///
  typedef B<C<D>> SomeTypedefOfTemplates;
};

我正在为我的项目创建一个Doxygen文档.最近,我使用\addtogrouptag 对相关类进行了分组.在此之后,我的文档中有一个模块选项卡.它显示了所有模块.我想在同一页面上的模块名称下面的模块名称下面添加一些描述.我怎么能用Doxygen做到这一点？

这是我的标签

/*! \addtogroup test test
 *  Test Testing a group in doxygen
 *  @{
 */

我已经在我的mac上成功安装了Doxygen和GraphViz(运行Lion OS),但是当我使用graphViz运行doxygen时,我收到以下错误消息:

1) sh: dot: command not found
2) Problems running dot: exit code=127, command='dot', arguments='"/Users/../xxx.dot" -Tpdf -o
3) error: problems opening map file /Users/.../xxx_graph.map for inclusion in the docs!
If you installed Graphviz/dot after a previous failing run, 
try deleting the output directory and rerun doxygen.

我的Graphviz/dot路径一定是个问题,但我不知道如何解决它.

我已经使用MacPorts安装了Graphviz,但我仍然收到相同的错误消息.

我该怎么做才能解决这个问题？提前致谢!

我刚开始使用 doxygen，可能不熟悉所有可用的设置。我查看了配置文件中的所有标签和选项，但未能找到任何相关的操作标签。

有没有办法强制 doxygen 在 C/C++ 中索引外部？现在它们只是简单地添加到源文件中的其他变量列表中。

编辑：据我目前所见，doxygen 根本不了解外部。它在 html 文件中为这些变量或函数生成一个对随机（第一次看到）位置的引用。

假设我在doxygen页面中有一个部分page_Examples叫做section_Example.是否可以直接链接到该部分？

链接到页面已完成\link page_Examples Examples \endlink,但我想直接进入该部分!谢谢.

在这个 Doxygen 生成的帮助页面http://api.fluffyunderware.com/curvy/index.html 上，有一个主页的分层文档索引和一个目录。如何在我自己的文档中复制此功能？

这是提到的页面的屏幕截图：

我在 PHP 中有两个类：Figure和Circle. Circle延伸Figure。Figure有方法draw()。Circle继承此方法并覆盖它。

该draw()方法在父类中被注释，但它在类中没有注释，Circle因为它将继承它。

/**
 * Description of Figure  
 *
 * @author admin
 */
class Figure{

    /**
     * Does something
     */
    public function draw() {

    }
}

/**
 * Description of Circle  
 *
 * @author admin
 */
class Circle extends Figure{


    public function draw() {
        //overriden method
    }
}

Doxygen 说：“警告：Circle 类的成员 draw()（函数）没有记录。”

如何让 Doxygen 放入继承的注释中？

Doxygen 可以在以下简短示例中正常工作：

/** \file */

/// This is an integer
typedef int myInteger;

/// This is the same as \ref myInteger
typedef myInteger myOtherInteger;

但是myInteger如果我将它放入命名空间，它不会解析对的引用。

/** \file */

namespace bar {

/// This is an integer
typedef int myInteger;

/// This is the same as \ref myInteger
typedef myInteger myOtherInteger;

}

请注意，myInteger现在提到的两个都不是链接。它还抱怨：

警告：无法为 \ref 命令解析对 `myInteger' 的引用

写作\ref bar::myInteger没有帮助。

我怎样才能解决这个问题？

我有 doxygen 1.8.13。

我需要你的帮助在 Qt creator 上安装 doxygen 插件。许多教程和视频都建议使用此链接来获取它，但它似乎不再起作用。不幸的是，我没有找到任何其他的。

我知道这个会安装doxygen，但会在安装插件后完成。

我不太擅长安装程序，因此欢迎任何提示。非常感谢您的帮助。

祝你有美好的一天！

我对 c 代码使用 doxygen 文档。现在我想将这些文档移动到一个单独的 dox 文件中。是否有任何快速简单的解决方案可以在 vim 中提取这些 doxygen 注释？

/** 
 *....
 *....
 */ 

/*!
 *...
 *...
 *...
 */

我知道我可以y%在光标第一次打开时使用块中的所有代码/。但是我们的文档遍布整个文件，很难一一拉出。