Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-08-18 06:35:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix(cmakev2/component): correct function descriptions and typos

Browse Source 
Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2025-07-24 19:26:21 +02:00
committed by BOT
parent d669f1841b
commit a71a2e1c4e
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
tools/cmakev2/component.cmake
View File

@@ -11,8 +11,9 @@ include(build)
.. code-block:: cmake
idf_component_set_property(<property> <value> [APPEND])
idf_component_set_property(<component> <property> <value> [APPEND])
:component[in]: Component name, target, target alias or interface.
:property[in]: Property name.
:value[in]: Property value.
:APPEND: Append the value to the property's current value instead of
@@ -46,9 +47,10 @@ endfunction()
.. code-block:: cmake
idf_component_get_property(<variable> <property> [GENERATOR_EXPRESSION])
idf_component_get_property(<variable> <component> <property> [GENERATOR_EXPRESSION])
:variable[out]: Variable to store the value in.
:component[in]: Component name, target, target alias or interface.
:property[in]: Property name to get the value of.
:GENERATOR_EXPRESSION: Obtain the generator expression for the property
rather than the actual value.
@@ -219,7 +221,7 @@ endfunction()
__get_component_interface_or_die(COMPONENT <component>
OUTPUT <variable>)
:COMPONENT[int]: Component name, target, target alias or interface.
:COMPONENT[in]: Component name, target, target alias or interface.
:OUTPUT[out]: Output variable to store the component interface.
A simple wrapper for ``__get_component_interface`` that aborts the build