feat(cmakev2): Export public API in the generated build system v2 reference

Promote the build system v2 functions and macros used by the
examples/build_system/cmakev2 examples to the generated API reference,
document the component-scope and version variables, the public build
properties, and the public component properties, and add cmakev2
build_property and component_property directives with dedicated Build
Properties and Component Properties sections to the esp-docs extension.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2026-06-18 14:48:26 +02:00
parent 67fdf46105
commit f2c3fd3966
7 changed files with 238 additions and 66 deletions
+6 -6
View File
@@ -288,7 +288,7 @@ function(__dump_library_properties libraries)
endforeach()
endfunction()
#[[
#[[api
.. cmakev2:function:: idf_build_library
.. code-block:: cmake
@@ -547,7 +547,7 @@ function(idf_build_library library)
__component_validation_run_checks(LIBRARY "${library}")
endfunction()
#[[
#[[api
.. cmakev2:function:: idf_build_executable
.. code-block:: cmake
@@ -747,7 +747,7 @@ function(__get_components_metadata)
set(${ARG_OUTPUT} "${components_json}" PARENT_SCOPE)
endfunction()
#[[
#[[api
.. cmakev2:function:: idf_build_generate_metadata
.. code-block:: cmake
@@ -906,7 +906,7 @@ function(idf_build_generate_metadata)
endif()
endfunction()
#[[
#[[api
.. cmakev2:function:: idf_build_binary
.. code-block:: cmake
@@ -1133,7 +1133,7 @@ function(idf_sign_binary binary)
set_target_properties(${ARG_TARGET} PROPERTIES EXECUTABLE_TARGET ${executable})
endfunction()
#[[
#[[api
.. cmakev2:function:: idf_flash_binary
.. code-block:: cmake
@@ -1214,7 +1214,7 @@ function(idf_flash_binary binary)
endif()
endfunction()
#[[
#[[api
.. cmakev2:function:: idf_check_binary_size
.. code-block:: cmake