doxygen 外部命令/排除除

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

是否有可能从输出中排除所有记录的函数、类、页面,除了那些特别标记的?

我有一个有据可查的(大)项目。类的大部分功能都是内部的。但对于客户,我将创建一个关于一些功能和页面的文档。 (就像创建 API 文档,但将所有内容隐藏在后面)。如果不使用 @internal 命令标记所有内容,是否有可能做到这一点?我正在寻找相反的命令。

有没有什么聪明的方法可以用条件文档(@if)来做到这一点? 目前,按名称或路径过滤输入文件并仅使用一些也不是那么容易。

例子:

## @package pyexample
#  Documentation for this module.
#  More details.

'''@external @page Public documentation
   You can call the function func(), the rest is top secret internal stuff
'''
 
## @external Documentation for a public function.
def func():
    p=PyClass()
    p.PyMethod()
 
## Documentation for a class.
#
#  More details.
class PyClass:
   
    ## The constructor.
    def __init__(self):
        self._memVar = 0;
   
    ## Documentation for a method.
    #  @param self The object pointer.
    def PyMethod(self):
        pass
     
    ## A class variable.
    classVar = 0;

外部文档应该只包含页面

public documentation
func()
的文档。

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