如何（有选择地）禁用自动链接到doxygen中的示例

Question

我有以下问题：我想将代码示例添加到我的doxygen文档中。它可以正常工作，但是我有很多示例，每个示例都需要调用相同的功能，例如 myinit（）。现在， myinit（）的生成文档包含所有使用 myinit（）的示例，这基本上是指：所有示例。我想为 myinit（）提到的一个一个，即，它证明了它的用法，但不是全部。

这是一个示例：

=============== MyEspressoMachine.h ==============
/** @example exTurnOn.cpp */
/** @example exMakeEspresso.cpp */
/** @example exClean.cpp */
/** @example exTurnOff.cpp */

/** My espresso machine. */
class MyEspressoMachine {
public:
    /** Turns the espresso machine on */
    void turnOn() {};
    /** Makes a delicious espresso.  */
    void makeEspresso() {};
    /** Cleans the espresso machine.  */
    void clean() {};
    /** Turns the espresso machine off */
    void turnOff() {};
};
=============== exTurnOn.cpp =============
#include "MyEspressoMachine.h"
int main() {
    MyEspressoMachine m;
    m.turnOn();
    m.turnOff();
}
=============== exMakeEspresso.cpp ==============
#include "MyEspressoMachine.h"
int main() {
    MyEspressoMachine m;
    m.turnOn();
    m.makeEspresso();
    m.turnOff();
}
=============== exClean.cpp ==============
#include "MyEspressoMachine.h"
int main() {
    MyEspressoMachine m;
    m.turnOn();
    m.clean();
    m.turnOff();
}
=============== exTurnOff.cpp ==============
#include "MyEspressoMachine.h"
int main() {
    MyEspressoMachine m;
    m.turnOn();
    m.turnOff();
}
=============== Doxyfile ==============
EXAMPLE_PATH = .

这是结果（doxygen 1.8.7）：

在我的真实情况下，它不仅是四个示例，而且是数十个示例。但是，在 Turnon的文档中，我只想出现 earpurnon.cpp 。

有什么想法吗？

再见， 洛基

Answer 1

不是解决问题的答案，而是解决问题。

Doxygen中的输出对我来说也有些奇怪，但是也许有一个原因。
看来文件开头提到的示例不仅在类级别上，而且在类方法中（部分）提到。

我建议的是第一个解决方法：

/** \file */

/** My espresso machine. */
class MyEspressoMachine {
public:
    /** Turns the espresso machine on
     *
     * @myExample exTurnOn.cpp
     */
    void turnOn() {}
    /** Makes a delicious espresso.
     *
     * @myExample exMakeEspresso.cpp
     */
    void makeEspresso() {}
    /** Cleans the espresso machine.
     *
     * @myExample exClean.cpp
     */
    void clean() {}
    /** Turns the espresso machine off
     *
     * @myExample exTurnOff.cpp
     */
    void turnOff() {}
};

并在Doxyfile中设置：

ALIASES = myExample="**Example:** ^^ @include"

或者适用于1.8.7版本：

ALIASES = myExample="**Example:** \n @include"