Exclude test folder from Doxygen API reference

Open
  • Is something wrong?
#1,341 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #1441 by @wyf027 — closed without merging

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
cmake, cpp
Domain
documentation

Research direction

Start by reading the CMake configuration where Doxygen is set up and check how DOXYGEN_EXCLUDE_PATTERNS is currently configured. The issue suggests excluding the test directory; confirm the variable uses the correct source directory path and pattern. Done when test-folder classes no longer appear in the generated API reference.

Written by the indexing model from the issue text.

Description

documentation enhancement help wanted

Hi,

This should probably not be in the docs:

https://codedocs.xyz/jbeder/yaml-cpp/classVeryLoooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo72732a7a8cd04f0ab9551a6aaa86a0c2.html

You can exclude directories by setting the DOXYGEN_EXCLUDE_PATTERNS CMake variable, for example:

set(DOXYGEN_EXCLUDE_PATTERNS ${CMAKE_SOURCE_DIREC}/test/*)

Regards,
Jules

Dominant language
C++
Stars
6.1k
Forks
2.2k
Avg merge
22h 2m
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jbeder/yaml-cpp

All issues in jbeder/yaml-cpp

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.