向Doxygen生成的Python文档添加示例

我试图在Python类的描述中添加一个示例。不知什么原因，它似乎不起作用。该示例被添加到生成的HTML页面上的“示例”选项卡中，但在类的描述中没有显示指向该示例的链接。我已经阅读了doxygen手册中有关特殊命令“@example”的部分，但我仍然不知道如何正确执行该命令。似乎无论我把@example命令放在哪里，链接都不会显示出来。我使用的是doxygen 1.8.5

一个简化的Python类，其中应显示指向示例的链接：

class TestClass:

    ## The constructor.
    #  @param self The object pointer.
    def __init__(self):
        self.__value = 0

    ## Stores a value.
    #  @param value The value to be stored.        
    def setValue(self, value):
        self.__value = value

    ## Gets stored value.
    #  @return The stored value.                
        def getValue(self):
        return self.__value

## @example TestClass_Example.py
#  This is an example of how to use TestClass  

示例如下所示：

from TestClass import TestClass

def main():
    myTestClass = TestClass()
    myTestClass.setValue(37)
    print "The stored value is:", myTestClass.getValue()    

if __name__ == '__main__':
    main()

感谢您的帮助。

可以找到答案

简而言之：您不能使用特殊命令，例如使用doxygen的python语法的示例。 必须使用以开头的注释，然后使用特殊命令

请注意，在这种情况下，doxygen的任何特殊命令都不可用 支持

还有另一种使用注释记录Python代码的方法 首先。这些类型的注释块更符合 文档块对受支持的其他语言的工作方式 这也允许使用特殊命令

编辑：啊，对不起。。。只要读到你已经做了这件事

您确定doxygen知道文件的路径吗？它在同一个目录中吗？

---

尝试在doxygen配置中设置示例路径？

实际上，我已经将示例文件目录添加到配置文件的示例路径中，并且假设示例已添加到输出HTML的“示例”选项卡中，我想这不是问题所在。