-
-
Notifications
You must be signed in to change notification settings - Fork 710
DOC: Corrected setting for CASE_SENSE_NAMES
#5293
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Corrected setting for CASE_SENSE_NAMES
#5293
Conversation
The default setting for `CASE_SENSE_NAMES` (in doxygen) is `SYSTEM` which means that on Linux it is set to `YES` and on (e.g.) Windows to `NO` (see analysis in InsightSoftwareConsortium#5262 (comment)). Seen the usage of the `EXCLUDE_PATTERN` `*/test*` this meant on Windows that also the directory with the name `TestKernel` was matched and thus excluded. Setting the `CASE_SENSE_NAMES` explicitly to `YES` prevents this (on Linux it won't have any effect as here the default was sufficient). Note: Due to a bug in doxygen (see doxygen/doxygen#11519) this would still exclude the pattern. The new setting will only have an effect, on Windows, when, the not yet released, doxygen 1.14.0 or newer will be used.
|
Should this file be updated too? Can someone remind me why do we have two, nearly identical files? |
|
Indeed a bit strange to have 2 nearly the same files, but when they serve to generated different types of documentation it would be good to have them and to update the file too. I see there are more differences, one notable is about the recent change regarding: |
|
@albert-github fantastic! Yes, the config files could be consolidated. The wrapping was merged into the repository from a separate repository, and this is an artifact. |
|
Merging this as-is. Consolidation can be a new PR. |
Shouldn't there be an issue created for this? |
|
Thanks for creating the issue and identifying which files need to be updated. |
The default setting for
CASE_SENSE_NAMES(in doxygen) isSYSTEMwhich means that on Linux it is set toYESand on (e.g.) Windows toNO(see analysis in #5262 (comment)). Seen the usage of theEXCLUDE_PATTERN*/test*this meant on Windows that also the directory with the nameTestKernelwas matched and thus excluded. Setting theCASE_SENSE_NAMESexplicitly toYESprevents this (on Linux it won't have any effect as here the default was sufficient). Note: Due to a bug in doxygen (see doxygen/doxygen#11519) this would still exclude the pattern. The new setting will only have an effect, on Windows, when, the not yet released, doxygen 1.14.0 or newer will be used.PR Checklist