CMake Add documentation to custom defined properties #2131
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.
TYPE: bug fix
KEYWORDS: compilation, cmake
SOURCE: internal
DESCRIPTION OF CHANGES:
Problem:
As noted in #2124, prior to CMake 3.23, when defining custom properties the
BRIEF_DOCS
andFULL_DOCS
are non-optional arguments.Solution:
Add proper documentation to the custom properties to allow minimum CMake version requirements of the project to remain the same.
ISSUE:
Addresses #2124
TESTS CONDUCTED:
RELEASE NOTE:
Add documentation to custom properties in CMake to fix compatibility with older versions.