docs: standardize Doxyfile and README for vcpkg deployment#431
Merged
Conversation
- Set TIMESTAMP=NO for reproducible builds - Add QT_AUTOBRIEF=NO, WARN_IF_INCOMPLETE_DOC=YES - Add *.md to FILE_PATTERNS - Remove redundant mainpage.dox from INPUT - Add missing HTML settings (COLORSTYLE, CODE_FOLDING, SIDEBAR) - Standardize EXCLUDE_PATTERNS - Add vcpkg install instructions to README Quick Start Closes #430
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
* docs: standardize Doxyfile and README for vcpkg deployment - Set TIMESTAMP=NO for reproducible builds - Add QT_AUTOBRIEF=NO, WARN_IF_INCOMPLETE_DOC=YES - Add *.md to FILE_PATTERNS - Remove redundant mainpage.dox from INPUT - Add missing HTML settings (COLORSTYLE, CODE_FOLDING, SIDEBAR) - Standardize EXCLUDE_PATTERNS - Add vcpkg install instructions to README Quick Start Closes #430 * docs(headers): add @code usage example to main public header Relates to #430
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Standardize Doxyfile settings and add vcpkg installation instructions to README for vcpkg deployment readiness.
Change Type
Affected Components
Doxyfile- Doxygen configurationREADME.md- Project documentationWhy
Related Issues
Motivation
Prepare documentation for vcpkg registry publishing. The Doxyfile needed several settings standardized (reproducible builds, missing warnings, exclude patterns), and the README lacked vcpkg installation instructions.
Where
Files Changed
DoxyfileREADME.mdHow
Doxyfile Changes
TIMESTAMP=NOfor reproducible documentation buildsQT_AUTOBRIEF=NOafterJAVADOC_AUTOBRIEFWARN_IF_INCOMPLETE_DOC=YESafterWARN_AS_ERROR*.mdtoFILE_PATTERNSfor markdown documentation./mainpage.doxfromINPUT(already usingUSE_MDFILE_AS_MAINPAGE = README.md)HTML_COLORSTYLE=AUTO_LIGHT,HTML_CODE_FOLDING=YES,FULL_SIDEBAR=NO*/_deps/*and*/node_modules/*toEXCLUDE_PATTERNSREADME Changes
vcpkg installcommand and CMake integration snippetTesting Done