Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Risto97 committed Sep 24, 2024
1 parent 4262e46 commit 104eb65
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions cmake/utils/option.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,18 @@ function(option_enum VARIABLE DESCRIPTION ENUM_VALUES DEFAULT)
endif()
endfunction()

#[[[
# Create a CMake integer option that can be modified through CLI.
# Option defined this way will be visible in `cmake-gui` interface as well as SoCMake `help_options()` help menu.
# To override the variable use `cmake -D<VARIABLE>=<VALUE>`
#
# :param VARIABLE: name of the variable.
# :type VARIABLE: string
# :param DESCRIPTION: short description string for the variable
# :type DESCRIPTION: string
# :param DEFAULT: default value of the variable
# :type DEFAULT: string
#]]
function(option_string VARIABLE DESCRIPTION DEFAULT)
__define_socmake_option(${VARIABLE} "String" ${DESCRIPTION} ${DEFAULT})

Expand Down

0 comments on commit 104eb65

Please sign in to comment.