generate_doxygen_fallback_indexes.py File Reference

Go to the source code of this file.

Namespaces
namespace	generate_doxygen_fallback_indexes

Functions
str	generate_doxygen_fallback_indexes.doxygen_file_page (str name)
str	generate_doxygen_fallback_indexes.doxygen_file_page_with_path (str rel_path)
bool	generate_doxygen_fallback_indexes.needs_files_fallback (Path path)
bool	generate_doxygen_fallback_indexes.needs_structs_fallback (Path path)
str	generate_doxygen_fallback_indexes.resolve_doxygen_file_href (Path html_dir, str rel_path)
str	generate_doxygen_fallback_indexes.make_repo_href (str rel_path)
list[tuple[str, str, str]]	generate_doxygen_fallback_indexes.collect_file_rows (Path repo_root, Path html_dir, str base_dir, set[str] suffixes)
list[tuple[str, str, str]]	generate_doxygen_fallback_indexes.collect_all_source_like_files (Path repo_root, Path html_dir)
list[tuple[str, str, str]]	generate_doxygen_fallback_indexes.collect_struct_rows (Path repo_root, Path html_dir)
set[str]	generate_doxygen_fallback_indexes.extract_struct_names (str text)
str	generate_doxygen_fallback_indexes.categorize_struct (str name)
str	generate_doxygen_fallback_indexes.render_link (str label, str href)
str	generate_doxygen_fallback_indexes.render_rows (list[tuple[str, str, str]] rows, str empty_msg)
str	generate_doxygen_fallback_indexes.section_table (str title, str rows_html)
str	generate_doxygen_fallback_indexes.render_page (str title, str intro, str body_html)
None	generate_doxygen_fallback_indexes.write_structured_file_index (Path repo_root, Path html_dir)
None	generate_doxygen_fallback_indexes.write_structured_struct_index (Path repo_root, Path html_dir)
None	generate_doxygen_fallback_indexes.write_fallback_files_page (Path repo_root, Path html_dir)
None	generate_doxygen_fallback_indexes.write_fallback_struct_page (Path repo_root, Path html_dir)
int	generate_doxygen_fallback_indexes.main ()

Variables
dict	generate_doxygen_fallback_indexes.HEADER_SUFFIXES = {".h", ".hpp"}
dict	generate_doxygen_fallback_indexes.SOURCE_SUFFIXES = {".c", ".cc", ".cpp"}
dict	generate_doxygen_fallback_indexes.SCRIPT_SUFFIXES = {".py", ".sh", ".flow"}
str	generate_doxygen_fallback_indexes.REPO_BLOB_URL = "https://github.com/VishalKandala/PICurv/blob/main/"
dict	generate_doxygen_fallback_indexes.IGNORED_STRUCT_NAMES = {"Name"}
	generate_doxygen_fallback_indexes.NAMED_STRUCT_RE = re.compile(r"\bstruct\s+([A-Za-z_]\w*)\s*\{")
	generate_doxygen_fallback_indexes.TYPEDEF_START_RE = re.compile(r"^\s*typedef\s+struct(?:\s+([A-Za-z_]\w*))?")
	generate_doxygen_fallback_indexes.TYPEDEF_END_RE = re.compile(r"^\s*}\s*([A-Za-z_]\w*)\s*;")