FEX-Emu/FEX
1
0
Fork 0
mirror of https://github.com/FEX-Emu/FEX.git synced 2024-11-27 00:30:40 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Scripts: Add a documentation comment in doc_outline_generator.py

Browse Source
This commit is contained in:
Stefanos Kornilios Mitsis Poiitidis 2021-03-30 11:53:11 +03:00
parent 2b10b9792b
commit 458bebf598
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Scripts/doc_outline_generator.py
View File

@ -1,5 +1,22 @@
#!/usr/bin/python3
# Tag Format
# $info$
# glossary: <name> ~ <definition> (Optional, registers or replaces a glossary entry)
# glossary: IR ~ Intermidiate Representation, a of storage for our high-level opcode representation
# glossary: SSA ~ Single Static Assignment, a form of representing IR in memory
# glossary: Basic Block ~ A block of instructions with no control flow, terminated by control flow
# glossary: Fragment ~ A Collection of basic blocks, possible an entire guest function or a fraction of it
# category: <name> ~ <description> (Optional, registers or replaces a category description)
# category: backend ~ Concerns itself with generating binary code from (optimized) IR
# meta: <name> ~ <description> (Optional, registers or replaces a meta, aka tag, description)
# meta: backend|arm64 ~ Arm64 Splatter backend
# tags: <meta name> [, <meta name>, ...] (Required if info tag exists)
# tags: backend|arm64
# desc: <short file description> (Optional)
# desc: Main glue logic of the arm64 splatter backend
# $end_info$
import re
from pathlib import Path
import sys