Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the correct syntax for using EXCLUDE_SYMBOLS?

Tags:

doxygen

I have a class like so:

class Foo {
public:
  /** blah blah */
  void bar();
}

I want to exclude this from the documentation, but EXCLUDE_SYMBOLS isn't working for me. I have tried the following (one by one):

EXCLUDE_SYMBOLS = Foo::bar
EXCLUDE_SYMBOLS = Foo::*
EXCLUDE_SYMBOLS = Foo
EXCLUDE_SYMBOLS = *

None of these is working. Is there a mistake in my syntax, or is there some other configuration I need to change for this to take effect?

I have looked at several questions on SO, but the syntax used in those answers doesn't work for me.

like image 987
Masked Man Avatar asked Nov 09 '13 06:11

Masked Man


1 Answers

This exclude expression works good in my case with doxygen 1.8.14:

EXCLUDE_SYMBOLS = "TestTemplate< T, std::string >" "TestNS::*" "TestClass*"

In EXCLUDE_SYMBOLS it is specified or exact symbol name or a '*'-pattern. Exact symbol name may be retrieved from doxygen XML output (try enable it in Doxyfile).

like image 93
zpah Avatar answered Oct 09 '22 02:10

zpah