Doxygen: hide markdown file from related pages

1
votes

I want to document test cases that consist of multiple files with a separate markdown file:

tests/test_a/
             file1
             file2
             test_a.md

However, the file test_a.md (which includes the Doxygen documentation for the test) now shows up in the 'related pages' tab of Doxygen, which is annoying if you have a lot of tests. Is there any way to prevent this?

1
doxygen

1 Answers

2
votes

That's probably exactly what EXCLUDE_PATTERNS is for:

EXCLUDE_PATTERNS += */tests/*.md

Edit:
That will exclude all .md files somewhere in the tests/ directory tree from being processed by Doxygen.

Edit2:
A potential workaround to let Doxygen still process the files but don't let them show up under "related pages" would be to explicitly declare them as subpages of another page:

@subpage tests_testa

This, however, requires that the *.md file in test_a defines a page including the respective identifier, i.e. {#tests_testa} with the example above.