Kernel now puts docs in kernel/docs, and move Doxyfile into kernel/
This commit is contained in:
parent
d892e14633
commit
f8864484a9
2
.github/workflows/main.yml
vendored
2
.github/workflows/main.yml
vendored
@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Generate kernel docs
|
- name: Generate kernel docs
|
||||||
uses: mattnotmitt/doxygen-action@v1.1.0
|
uses: mattnotmitt/doxygen-action@v1.1.0
|
||||||
with:
|
with:
|
||||||
doxyfile-path: "./ActionDoxyfile"
|
doxyfile-path: "./kernel/ActionDoxyfile"
|
||||||
- name: Put files in the right place
|
- name: Put files in the right place
|
||||||
run: sudo mv kerneldoc/html docsite/kernel; sudo cp docindex.html docsite/index.html
|
run: sudo mv kerneldoc/html docsite/kernel; sudo cp docindex.html docsite/index.html
|
||||||
|
|
||||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -16,4 +16,4 @@ serout
|
|||||||
vga_drv/vga_drv
|
vga_drv/vga_drv
|
||||||
.vagrant
|
.vagrant
|
||||||
.vscode
|
.vscode
|
||||||
kerneldoc
|
kernel/docs
|
||||||
|
2
Makefile
2
Makefile
@ -89,4 +89,4 @@ clean:
|
|||||||
@rm -rf initrd/* kernel/*.o drivers/*/*.o drivers/*/*/*.o cpu/*/*.o fs/*.o libc/libc.a kernel/cstart.o cpu/memory.h os.iso */*.elf sysroot/boot/initrd.tar
|
@rm -rf initrd/* kernel/*.o drivers/*/*.o drivers/*/*/*.o cpu/*/*.o fs/*.o libc/libc.a kernel/cstart.o cpu/memory.h os.iso */*.elf sysroot/boot/initrd.tar
|
||||||
|
|
||||||
doc: $(C_SOURCES) $(C_HEADERS)
|
doc: $(C_SOURCES) $(C_HEADERS)
|
||||||
@doxygen > /dev/null
|
@doxygen kernel/Doxyfile > /dev/null
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
PROJECT_NAME = "MyOS Kernel"
|
PROJECT_NAME = "MyOS Kernel"
|
||||||
OUTPUT_DIRECTORY = ./kerneldoc
|
OUTPUT_DIRECTORY = ./kerneldocs
|
||||||
OPTIMIZE_OUTPUT_FOR_C = YES
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
||||||
TYPEDEF_HIDES_STRUCT = YES
|
TYPEDEF_HIDES_STRUCT = YES
|
||||||
EXTRACT_STATIC = YES
|
EXTRACT_STATIC = YES
|
@ -58,7 +58,7 @@ PROJECT_LOGO =
|
|||||||
# 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 = /Users/peterterpstra/Desktop/projects/os/kerneldoc
|
OUTPUT_DIRECTORY = ./kernel/docs
|
||||||
|
|
||||||
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
||||||
# directories (in 2 levels) under the output directory of each output format and
|
# directories (in 2 levels) under the output directory of each output format and
|
Loading…
x
Reference in New Issue
Block a user