espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-08 15:14:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Include paths for chip specific headers now depend on target

Browse Source 
Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
This commit is contained in:
Marius Vikhammer
2019-12-13 10:48:21 +08:00
committed by Angus Gratton
parent 1a90470f02
commit 83521dbc51
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Doxyfile
View File

@@ -217,7 +217,7 @@ INPUT = \
## Himem ## Himem
$(IDF_PATH)/components/esp32/include/esp32/himem.h \ $(IDF_PATH)/components/esp32/include/esp32/himem.h \
## Interrupt Allocation ## Interrupt Allocation
$(IDF_PATH)/components/esp32/include/esp_intr_alloc.h \ $(IDF_PATH)/components/$(IDF_TARGET)/include/esp_intr_alloc.h \
## Watchdogs ## Watchdogs
## NOTE: for two lines below header_file.inc is not used ## NOTE: for two lines below header_file.inc is not used
$(IDF_PATH)/components/esp_common/include/esp_int_wdt.h \ $(IDF_PATH)/components/esp_common/include/esp_int_wdt.h \
@@ -233,7 +233,7 @@ INPUT = \
## ESP HTTPS OTA ## ESP HTTPS OTA
$(IDF_PATH)/components/esp_https_ota/include/esp_https_ota.h \ $(IDF_PATH)/components/esp_https_ota/include/esp_https_ota.h \
## Sleep ## Sleep
$(IDF_PATH)/components/esp32/include/esp_sleep.h \ $(IDF_PATH)/components/$(IDF_TARGET)/include/esp_sleep.h \
## Logging ## Logging
$(IDF_PATH)/components/log/include/esp_log.h \ $(IDF_PATH)/components/log/include/esp_log.h \
## Base MAC address ## Base MAC address
@@ -245,7 +245,7 @@ INPUT = \
## ULP Coprocessor - API Guides ## ULP Coprocessor - API Guides
## ##
## NOTE: for line below header_file.inc is not used ## NOTE: for line below header_file.inc is not used
$(IDF_PATH)/components/ulp/include/esp32/ulp.h \ $(IDF_PATH)/components/ulp/include/$(IDF_TARGET)/ulp.h \
$(IDF_PATH)/components/ulp/include/ulp_common.h \ $(IDF_PATH)/components/ulp/include/ulp_common.h \
## ##
## Application Level Tracing - API Reference ## Application Level Tracing - API Reference
@@ -254,7 +254,7 @@ INPUT = \
$(IDF_PATH)/components/app_trace/include/esp_sysview_trace.h \ $(IDF_PATH)/components/app_trace/include/esp_sysview_trace.h \
### Power management ### Power management
$(IDF_PATH)/components/esp_common/include/esp_pm.h \ $(IDF_PATH)/components/esp_common/include/esp_pm.h \
$(IDF_PATH)/components/esp32/include/esp32/pm.h \ $(IDF_PATH)/components/$(IDF_TARGET)/include/$(IDF_TARGET)/pm.h \
### esp_timer, High Resolution Timer ### esp_timer, High Resolution Timer
$(IDF_PATH)/components/esp_timer/include/esp_timer.h \ $(IDF_PATH)/components/esp_timer/include/esp_timer.h \
### esp_event, Event Loop Library ### esp_event, Event Loop Library

8
docs/idf_extensions/run_doxygen.py
View File

@@ -99,7 +99,7 @@ def convert_api_xml_to_inc(app, doxyfile):
if not os.path.exists(inc_directory_path): if not os.path.exists(inc_directory_path):
os.makedirs(inc_directory_path) os.makedirs(inc_directory_path)
header_paths = get_doxyfile_input_paths(doxyfile) header_paths = get_doxyfile_input_paths(app, doxyfile)
print("Generating 'api_name.inc' files with Doxygen directives") print("Generating 'api_name.inc' files with Doxygen directives")
for header_file_path in header_paths: for header_file_path in header_paths:
api_name = get_api_name(header_file_path) api_name = get_api_name(header_file_path)
@@ -116,7 +116,7 @@ def convert_api_xml_to_inc(app, doxyfile):
inc_file.write(rst_output) inc_file.write(rst_output)
def get_doxyfile_input_paths(doxyfile_path): def get_doxyfile_input_paths(app, doxyfile_path):
"""Get contents of Doxyfile's INPUT statement. """Get contents of Doxyfile's INPUT statement.
Returns: Returns:
@@ -148,6 +148,10 @@ def get_doxyfile_input_paths(doxyfile_path):
# extract header file path inside components folder # extract header file path inside components folder
m = re.search("components/(.*\.h)", line) # noqa: W605 - regular expression m = re.search("components/(.*\.h)", line) # noqa: W605 - regular expression
header_file_path = m.group(1) header_file_path = m.group(1)
# Replace env variable used for multi target header
header_file_path = header_file_path.replace("$(IDF_TARGET)", app.config.idf_target)
doxyfile_INPUT.append(header_file_path) doxyfile_INPUT.append(header_file_path)
# proceed reading next line # proceed reading next line