Skip to content
Snippets Groups Projects
Commit 8dead24a authored by Timo Koch's avatar Timo Koch Committed by Mathis Kelm
Browse files

[doxygen] Add filter for lines that should only be displayed in Doxygen

parent 92cfcd64
No related branches found
No related tags found
1 merge request!3474[python] update readme for new setup
......@@ -34,6 +34,12 @@ def _is_main_readme_file(path) -> bool:
return path == MAIN_README
def _enable_doxygen_only_content(line: str) -> str:
if line.startswith("<!--DOXYGEN_ONLY "):
return line.replace("<!--DOXYGEN_ONLY ", "").replace("-->", "")
return line
assert len(sys.argv[1]) > 1
filePath = abspath(sys.argv[1])
......@@ -49,7 +55,7 @@ if _is_main_readme_file(filePath):
# correctly (may be fixed in the most recent Doxygen version)
result_lines = []
for line in result.split("\n"):
result_lines.append(_add_header_label(line))
result_lines.append(_enable_doxygen_only_content(_add_header_label(line)))
# Print the final result for Doxygen to pick it up
print("\n".join(result_lines))
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment