add doxygen docs

This commit is contained in:
Chris Cromer 2021-07-26 02:47:25 -04:00
parent 9ab95c799e
commit 6aca7ae42e
23 changed files with 2728 additions and 9 deletions

3
.gitignore vendored
View File

@ -6,5 +6,6 @@ myshellin
*.gz
*.aux
*.out
compile_commands.json
.clangd
docs
refman.pdf

View File

@ -5,28 +5,39 @@ FILENAME=myshellin
SRC=src/myshellin.c src/loop.c src/console_line.c src/array.c src/builtins.c src/launch.c src/utils.c src/redirect.c
OBJ=$(SRC:.c=.o)
all: shell report
all: shell doc report
shell: $(OBJ)
$(CC) $(CFLAGS) -o $(FILENAME) $^ $(LDFLAGS)
doc:
# if doxygen is install create the code documentation
ifneq (, $(shell which doxygen))
doxygen doxygen.conf
make -C docs/latex
mv docs/latex/refman.pdf refman.pdf
endif
report:
# if pdflatex is installed create the report
ifneq (, $(shell which pdflatex))
make -C doc
mv doc/Informe.pdf Informe.pdf
make -C report
mv report/Informe.pdf Informe.pdf
else ifneq (, $(shell which pdftex))
make -C doc
mv doc/Informe.pdf Informe.pdf
make -C report
mv report/Informe.pdf Informe.pdf
endif
clean: cleanshell cleanreport
clean: cleanshell cleandoc cleanreport
cleanshell:
rm -f src/*.o $(FILENAME)
cleandoc:
rm -rf refman.pdf docs
cleanreport:
make -C doc clean
make -C report clean
rm -f Informe.pdf
.PHONY: all shell report clean cleanshell cleanreport
.PHONY: all shell doc report clean cleanshell cleandoc cleanreport

View File

@ -13,6 +13,9 @@ myshellin es un proyecto semestral del ramo Sistemas Operativos. El propósito d
- latex
- pdflatex
## Requisitos documentacón
- doxygen
## Compilar
### Software
@ -21,5 +24,8 @@ make shell
### Informe
make report
### Documentación
make doc
## Licencia
El proyecto es bajo la licencia "[The 3-Clause BSD License](LICENSE)".

122
compile_commands.json Normal file
View File

@ -0,0 +1,122 @@
[
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/utils.o",
"src/utils.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/utils.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/loop.o",
"src/loop.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/loop.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/array.o",
"src/array.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/array.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/builtins.o",
"src/builtins.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/builtins.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/launch.o",
"src/launch.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/launch.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/myshellin.o",
"src/myshellin.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/myshellin.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/console_line.o",
"src/console_line.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/console_line.c"
},
{
"arguments": [
"clang",
"-c",
"-Wall",
"-Isrc/include",
"-g",
"-std=c11",
"-o",
"src/redirect.o",
"src/redirect.c"
],
"directory": "/mnt/data/projects/myshellin",
"file": "src/redirect.c"
}
]

2579
doxygen.conf Normal file

File diff suppressed because it is too large Load Diff

View File

Before

Width:  |  Height:  |  Size: 185 KiB

After

Width:  |  Height:  |  Size: 185 KiB