具有C＃内部访问修饰符的Doxygen [英] Doxygen with C# internal access modifier

问题描述

我正在使用Doxygen为我正在从事的C＃项目生成一些API文档。我在此项目中有很多内部功能，并且不希望Doxygen在其生成的html中生成这些签名。

I am using Doxygen to generate some API docs for a C# project I am working on. I have quite a bit of "internal" functionality in this project and don't want Doxygen producing these signatures in the generated html it produces.

我曾尝试启用HIDE_FRIEND_COMPOUNDS，但是

I have tried enabling HIDE_FRIEND_COMPOUNDS but this still results in my internal classes being exposed in the generated documentation.

有人知道怎么做吗？

推荐答案

附加到Mac H的答案上，您必须设置以下其他配置参数才能使其正常工作：

Addon to Mac H's answer, you have to set these additional configuration parameters to make it work:

# The PREDEFINED tag can be used to specify one or more macro names that 
# are defined before the preprocessor is started (similar to the -D option of 
# gcc).     

PREDEFINED             = internal=private

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
# will be included in the documentation.  

EXTRACT_PRIVATE        = NO

# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
# evaluate all C-preprocessor directives found in the sources and include 
# files.

ENABLE_PREPROCESSING   = YES

# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
# names in the source code. If set to NO (the default) only conditional 
# compilation will be performed. Macro expansion can be done in a controlled 
# way by setting EXPAND_ONLY_PREDEF to YES.

MACRO_EXPANSION        = YES

# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
# then the macro expansion is limited to the macros specified with the 
# PREDEFINED and EXPAND_AS_DEFINED tags.

EXPAND_ONLY_PREDEF     = YES

这篇关于具有C＃内部访问修饰符的Doxygen的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！