Skip to content

Commit f204246

Browse files
authored
CMake Add documentation to custom defined properties (#2131)
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` and `FULL_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: 1. Tested on CMake v3.20.6 RELEASE NOTE: Add documentation to custom properties in CMake to fix compatibility with older versions.
1 parent c2e121f commit f204246

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

cmake/target_source_properties.cmake

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,16 @@ function( define_target_source_properties )
4242
SOURCE
4343
PROPERTY ${PROPERTY}
4444
# INHERITED # they will be "inherited" via target to source
45+
BRIEF_DOCS "Transitive property from target to file"
46+
FULL_DOCS "This property can override an existing property derived from a target"
4547
)
4648

4749
define_property(
4850
TARGET
4951
PROPERTY ${PROPERTY}
5052
# INHERITED # they will be "inherited" via target to source
53+
BRIEF_DOCS "Transitive property from target to file"
54+
FULL_DOCS "This property can be overridden on a per file basis"
5155
)
5256
endforeach()
5357
endfunction()

0 commit comments

Comments
 (0)