开发者

How to exclude variables from Doxygen output?

开发者 https://www.devze.com 2023-01-27 16:43 出处:网络
I am trying to get some XML documentation from Doxygen that includes the member functions and EXCLUDES the member variables.

I am trying to get some XML documentation from Doxygen that includes the member functions and EXCLUDES the member variables.

Is it possible to do that? From the doc 开发者_运维问答I could not find much...

Thank's!


You probably want to document everything that is in the public interface of your classes and skip all implementation details. If that's the case, you can use EXTRACT_PRIVATE = NO.


You could enter each variable name in the EXCLUDE_SYMBOL option. How many different variable names are there? Unless you created a similar pattern in each variable name ie.

Vehicle varCar, varScooter;

and then

EXCLUDE_SYMBOL = var*

within your config file. Just ensure no method or class name will match your pattern. I haven't come across an elegant solution for this problem though.


For Objective-C, it can be useful to declare ivars in the header (so that they can be used directly in categories or subclasses).

However, to get Doxygen to skip these, add the following:

EXCLUDE_SYMBOLS = SomeType \
AnotherType \   
_*

. . this depends on using the modern standard of naming ivars with a leading underscore character.

0

精彩评论

暂无评论...
验证码 换一张
取 消