kamkow1/mop3
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move kernel doxygen stuff to kernel/

Browse Source
This commit is contained in:
Kamil Kowalczyk
2025-12-30 17:04:05 +01:00
parent 34f1e0ba30
commit a6c3f4cf87
5 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs.mk
View File

@@ -1,8 +1,7 @@
docs: doxygen_kernel:
doxygen make -C kernel platform=$(platform) doxygen
docs: doxygen_kernel
mkdocs build mkdocs build
doxygen: .PHONY: docs doxygen_kernel
doxygen
.PHONY: docs doxygen

2
docs/index.md
View File

@@ -4,4 +4,4 @@ MOP3 is a hobby OS project of mine ;).
# Kernel documentation # Kernel documentation
- [Doxygen docs](doxygen/html/index.html) - [Doxygen docs](kernel/doxygen/html/index.html)

18
Doxyfile → kernel/Doxyfile
View File

@@ -74,7 +74,7 @@ PROJECT_ICON =
# entered, it will be relative to the location where Doxygen was started. If # entered, it will be relative to the location where Doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = docs/doxygen OUTPUT_DIRECTORY = ../docs/kernel/doxygen
# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format # sub-directories (in 2 levels) under the output directory of each output format
@@ -1005,7 +1005,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = kernel INPUT = .
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1109,12 +1109,12 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which Doxygen is # Note that relative paths are relative to the directory from which Doxygen is
# run. # run.
EXCLUDE = kernel/uACPI \ EXCLUDE = uACPI \
kernel/build \ build \
kernel/limine/limine.h \ limine/limine.h \
kernel/libk/printf.c \ libk/printf.c \
kernel/libk/printf.h \ libk/printf.h \
kernel/amd64/msr-index.h amd64/msr-index.h
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1474,7 +1474,7 @@ HTML_STYLESHEET =
# documentation. # documentation.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = doxytheme/doxygen-awesome.css HTML_EXTRA_STYLESHEET = ../doxytheme/doxygen-awesome.css
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note # other source files which should be copied to the HTML output directory. Note

5
kernel/Makefile
View File

@@ -32,4 +32,7 @@ format:
':!uACPI/tests/**' \ ':!uACPI/tests/**' \
':!libk/printf*') ':!libk/printf*')
.PHONY: all clean format doxygen:
doxygen
.PHONY: all clean format doxygen

0
doxygen_layout.xml → kernel/doxygen_layout.xml
View File