Step 1: Install Doxygen
brew install doxygen
Step 2: Set Up Doxygen Configuration
- Navigate to the root directory of your project.
- Run Doxygen to create a configuration file:
doxygen -g
Step 3: Configure Doxyfile
Open the Doxyfile
in a text editor and modify the following settings:
- Project Name and Version:
PROJECT_NAME = "Your Project Name"
PROJECT_NUMBER = "1.0"
- Source Directory: Set the path to your source files.
INPUT = ./src ./include
- Output Format: Enable HTML and/or LaTeX/PDF output.
GENERATE_HTML = YES
GENERATE_LATEX = YES
- Comments Style: Ensure Doxygen recognizes your code comments.
JAVADOC_AUTOBRIEF = YES # For Javadoc-style comments
MULTILINE_CPP_IS_BRIEF = YES
- Recursive Search: If you have subdirectories, enable recursive searching.
RECURSIVE = YES
- Exclude Directories: If there are directories or files you don’t want to document.
EXCLUDE = ./tests ./build