Refactor#101
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s Doxygen documentation output to better reflect the current codebase and adds Mermaid diagram support via a custom HTML footer, alongside introducing a standard pull request template.
Changes:
- Add a custom Doxygen HTML footer (
footer.html) that loads Mermaid and converts Mermaid-like code blocks into rendered diagrams. - Update
DoxygenConfigto include additional input directories and exclude more build/test artifacts from the generated docs. - Regenerate a large set of Doxygen HTML/LaTeX outputs and add a PR template under
.github/.
Reviewed changes
Copilot reviewed 81 out of 219 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| footer.html | New Doxygen HTML footer; injects Mermaid and renders Mermaid diagrams from code fragments. |
| DoxygenConfig | Adjusts Doxygen INPUT/EXCLUDE/FOOTER settings for documentation generation. |
| documentation/latex/timer_8hpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/structPPU_1_1OpcodeTrace.tex | Regenerated LaTeX API output. |
| documentation/latex/refman.tex | Regenerated LaTeX manual index/inputs. |
| documentation/latex/op__0B_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/op__0A_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/op__09_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/op__08_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/op__06_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/op__05_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/op__04_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/files.tex | Regenerated LaTeX file index output. |
| documentation/latex/common_8hpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__0F_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__0E_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__0D_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__0C_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__0B_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__0A_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__09_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__08_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__07_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__06_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__05_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__04_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__03_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__02_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__01_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/cb__op__00_8cpp_source.tex | Regenerated LaTeX source listing output. |
| documentation/latex/annotated.tex | Regenerated LaTeX class list output. |
| documentation/html/success_8hpp_source.html | Regenerated HTML output; footer injection visible. |
| documentation/html/structrom__header-members.html | Regenerated HTML output; footer injection visible. |
| documentation/html/search/searchdata.js | Regenerated HTML search index data. |
| documentation/html/search/pages_f.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_e.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_d.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_c.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_b.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_a.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_9.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_8.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_7.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_6.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_5.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_4.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_3.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_2.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_1.js | Regenerated HTML search index pages data. |
| documentation/html/search/pages_0.js | Regenerated HTML search index pages data. |
| documentation/html/search/classes_7.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_6.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_5.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_4.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_3.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_2.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_1.js | Regenerated HTML search index classes data. |
| documentation/html/search/classes_0.js | Regenerated HTML search index classes data. |
| documentation/html/search/all_f.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_e.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_d.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_c.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_b.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_a.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_9.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_8.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_7.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_6.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_5.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_4.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_3.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_2.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_10.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_1.js | Regenerated HTML search index “all” data. |
| documentation/html/search/all_0.js | Regenerated HTML search index “all” data. |
| documentation/html/readROM_8hpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/port_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/opcodes_8hpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/opcode__table_8hpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/opcode__table_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/op__08_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/op__06_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/op__05_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/op__04_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/navtreeindex0.js | Regenerated HTML navtree index JS. |
| documentation/html/navtreedata.js | Regenerated HTML navtree data JS. |
| documentation/html/menudata.js | Regenerated HTML menu JS data. |
| documentation/html/index.js | Regenerated HTML index JS data. |
| documentation/html/files_dup.js | Regenerated HTML files list JS data. |
| documentation/html/doxygen_crawl.html | Regenerated crawler index; reflects new docs set. |
| documentation/html/dir_d44c64559bbebec7f509842c48db8b23.js | Regenerated directory listing JS data. |
| documentation/html/dir_d44c64559bbebec7f509842c48db8b23.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_ca78d99c1cc2fbd9c7100f96927e8296.js | New/regenerated directory listing JS for utility_scripts. |
| documentation/html/dir_c184e51c84f2c3f0345bbc8a0d75d3e1.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_bfcd1d0d4605a2c8e82876bbc44dfc5c.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_aebb8dcc11953d78e620bbef0b9e2183.js | Regenerated directory listing JS data. |
| documentation/html/dir_aebb8dcc11953d78e620bbef0b9e2183.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_74739ff5fdb79cbfe4bc8a8496df703a.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_6dd65dd97d758c700871bf401c2e65f4.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_42cfb525e59460ed778c06a081612dfa.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/dir_2ba91d439ea0bdab0655953af2660edf.html | Regenerated directory listing HTML; footer injection visible. |
| documentation/html/common_8hpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/classProcessingUnit-members.html | Regenerated class members HTML; footer injection visible. |
| documentation/html/classPPU.js | New/regenerated class JS data. |
| documentation/html/classes.html | Regenerated class index HTML; footer injection visible. |
| documentation/html/cb__opcodes_8hpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/cb__op__07_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/cb__op__06_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/cb__op__05_8cpp_source.html | Regenerated HTML source listing output; footer injection visible. |
| documentation/html/annotated.html | Regenerated class list HTML; footer injection visible. |
| documentation/html/annotated_dup.js | Regenerated annotated JS data. |
| .github/pull_request_template.md | Adds a PR template to standardize descriptions, testing, and checklist items. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Note: If this tag is empty the current directory is searched. | ||
|
|
||
| INPUT = include src README.md | ||
| INPUT = include src utility_scripts pipline README.md |
| </small></address> | ||
| </div><!-- doc-content --> | ||
| <!--END !GENERATE_TREEVIEW--> | ||
| <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> |
Comment on lines
+19
to
+22
| mermaid.initialize({ | ||
| startOnLoad: true, | ||
| theme: 'dark' | ||
| }); |
| } | ||
| } | ||
| }); | ||
| mermaid.init(undefined, document.querySelectorAll('.mermaid')); |
Comment on lines
+37
to
+38
| fragment.parentNode.replaceChild(mermaidDiv, fragment); | ||
| } |
Jayesh-Dev21
had a problem deploying
to
github-pages
GitHub Actions
Failure
Jayesh-Dev21
had a problem deploying
to
github-pages
GitHub Actions
Failure
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.