alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-26 12:50:30 +00: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/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):
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")
for header_file_path in header_paths:
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)
def get_doxyfile_input_paths(doxyfile_path):
def get_doxyfile_input_paths(app, doxyfile_path):
"""Get contents of Doxyfile's INPUT statement.
Returns:
@@ -148,6 +148,10 @@ def get_doxyfile_input_paths(doxyfile_path):
# extract header file path inside components folder
m = re.search("components/(.*\.h)", line) # noqa: W605 - regular expression
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)
# proceed reading next line