Leahnaya/wut
1
0
Fork 0
mirror of https://github.com/devkitPro/wut.git synced 2026-09-11 12:46:01 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Simplify Doxygen generation (#447)

Browse Source 
* Use doxygen directly without going through cmake.

* Removed bogus include path.

* Do not install doxygen-latex if we're not using it.

* Allow unnamed symbols.

* Fixed WUT_DEPRECATED handling.

* Turned off INCLUDE_GRAPH and INCLUDED_BY_GRAPH.

---------

Co-authored-by: Daniel K. O. (dkosmari) <none@none>
This commit is contained in:
Daniel K. O.
2026-09-10 08:55:57 -03:00
committed by GitHub
parent bf0bb0bfa5
commit 07ef427382
3 changed files with 2792 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/doc.yml vendored
View File

@@ -27,10 +27,9 @@ jobs:
- name: Generate Documentation
run: |
sudo apt-get update
sudo apt-get install -y cmake doxygen doxygen-latex graphviz
sudo apt-get install -y doxygen graphviz
cd docs
sudo env WUT_VERSION=${{ steps.vars.outputs.tag }} cmake .
doxygen Doxyfile.docs >/dev/null
WUT_VERSION=${{ steps.vars.outputs.tag }} doxygen
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4.2.3

46
docs/CMakeLists.txt
View File

@@ -1,46 +0,0 @@
cmake_minimum_required(VERSION 3.9)
find_package(Doxygen)
if(DOXYGEN_FOUND)
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/../docs/Doxyfile.in)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
set(DOXYGEN_PROJECT_NAME "wut")
set(DOXYGEN_PROJECT_NUMBER $ENV{WUT_VERSION})
set(DOXYGEN_PROJECT_BRIEF "Wii U Toolchain")
set(DOXYGEN_GENERATE_HTML YES)
set(DOXYGEN_GENERATE_LATEX NO)
set(DOXYGEN_TAB_SIZE 3)
set(DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
set(DOXYGEN_INLINE_SIMPLE_STRUCTS YES)
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_EXTRACT_STATIC YES)
set(DOXYGEN_HIDE_SCOPE_NAMES YES)
set(DOXYGEN_SORT_MEMBER_DOCS NO)
set(DOXYGEN_RECURSIVE YES)
set(DOXYGEN_EXCLUDE_PATTERNS
"wut_structsize.h")
set(DOXYGEN_SOURCE_BROWSER YES)
set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
set(DOXYGEN_ENUM_VALUES_PER_LINE 1)
set(DOXYGEN_CLASS_DIAGRAMS NO)
set(DOXYGEN_COLLABORATION_GRAPH NO)
set(DOXYGEN_ENABLE_PREPROCESSING YES)
set(DOXYGEN_MACRO_EXPANSION YES)
set(DOXYGEN_EXPAND_ONLY_PREDEF YES)
set(DOXYGEN_PREDEFINED
"__cplusplus;"
"WUT_PACKED=;"
"WUT_ALIGNAS(x)=;"
"WUT_CHECK_OFFSET(Type,Offset,Field)=;"
"WUT_CHECK_SIZE(Type,Size)=;"
"WUT_PADDING_BYTES(Size)=;"
"WUT_UNKNOWN_BYTES(Size)=;"
"WUT_UNKNOWN_SIZE(x)=;")
doxygen_add_docs(docs
"${CMAKE_CURRENT_SOURCE_DIR}/../include"
"${CMAKE_CURRENT_SOURCE_DIR}/../docs")
endif()

2790
docs/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff