又是一个没有任何效果的doxygen

问题描述 投票:0回答:1

我第一次使用doxygen 1.8.15。我生成了 Doxyfiledoxygen -g 并尝试通过以下方式创建文档 doxygen.

在其他我有在基础目录 test.cpp 看起来像这样。

/**
 * This is a test. doc for an enum
 */
enum Test {
        /**
         * doc for an item
         */
        SomeItem
};

我希望html输出在 html/index.html 但这基本上是一个空网站。下面是输出的摘要。

Parsing files
Preprocessing /home/ernst/Ankrit/Software/Products/Recon/recon/Mbed/main.cpp...
Parsing file /home/ernst/Ankrit/Software/Products/Recon/recon/Mbed/main.cpp...
Reading /home/ernst/Ankrit/Software/Products/Recon/recon/Mbed/mbed_settings.py...
Parsing file /home/ernst/Ankrit/Software/Products/Recon/recon/Mbed/mbed_settings.py...
Preprocessing /home/ernst/Ankrit/Software/Products/Recon/recon/Mbed/test.cpp...
Parsing file /home/ernst/Ankrit/Software/Products/Recon/recon/Mbed/test.cpp...
Building group list...

正如你所看到的 test.cpp 是里面的。但在结果中,cpp上什么都没有显示,只有 mbed_settings. 我做错了什么?

doxygen
1个回答
1
投票

当例如cpp代码时,doxygen有一个 "习惯",当没有相应的信息时,它就找不到一些信息。.h 文件是存在的。

在``file`命令的帮助下,这个问题可以得到解决,所以代码:

/// \file

/**
 * This is a test. doc for an enum
 */
enum Test {
        /**
         * doc for an item
         */
        SomeItem
};

给出了要求的结果。

© www.soinside.com 2019 - 2024. All rights reserved.