fix(cmakev2/docs): keep only the very basic functions in API

Currently, we include numerous functions in the automatically generated
documentation for the build system API. Let's begin with only the
essential functions and gradually add more to the API based on requests
and actual needs.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2025-11-04 07:48:15 +01:00
parent 7cddcfa37f
commit 65052dfbdd
5 changed files with 21 additions and 20 deletions
+4 -4
View File
@@ -137,7 +137,7 @@ function(__get_component_sources)
set(${ARG_OUTPUT} "${sources}" PARENT_SCOPE)
endfunction()
#[[api
#[[
.. cmakev2:function:: target_linker_script
.. code-block:: cmake
@@ -195,7 +195,7 @@ function(target_linker_script target deptype scriptfiles)
endforeach()
endfunction()
#[[api
#[[
.. cmakev2:function:: idf_component_optional_requires
.. code-block:: cmake
@@ -282,7 +282,7 @@ function(__init_common_components)
idf_build_set_property(__COMMON_COMPONENTS_INITIALIZED YES)
endfunction()
#[[api
#[[
.. cmakev2:function:: idf_component_register
.. code-block:: cmake
@@ -500,7 +500,7 @@ function(idf_component_register)
idf_component_set_property("${COMPONENT_NAME}" COMPONENT_TYPE "${component_type}")
endfunction()
#[[api
#[[
.. cmakev2:function:: idf_build_component
.. code-block:: cmake