Browse Source

add doxygen docs

pull/17/head
Chris Cromer 3 months ago
parent
commit
6aca7ae42e
  1. 3
      .gitignore
  2. 27
      Makefile
  3. 6
      README.md
  4. 122
      compile_commands.json
  5. 2579
      doxygen.conf
  6. 0
      report/Enunciado - ProyectoSemestral.pdf
  7. 0
      report/Informe.tex
  8. 0
      report/Makefile
  9. 0
      report/code/builtins.txt
  10. 0
      report/code/environ.txt
  11. 0
      report/code/launch.txt
  12. 0
      report/code/loop.txt
  13. 0
      report/code/redirection.txt
  14. 0
      report/sections/codigo.tex
  15. 0
      report/sections/codigo/builtins.tex
  16. 0
      report/sections/codigo/ciclo.tex
  17. 0
      report/sections/codigo/environ.tex
  18. 0
      report/sections/codigo/permutar.tex
  19. 0
      report/sections/codigo/redireccion.tex
  20. 0
      report/sections/conclusiones.tex
  21. 0
      report/sections/funcionamiento.tex
  22. 0
      report/sections/introduccion.tex
  23. 0
      report/ubblogo.png

3
.gitignore

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

27
Makefile

@ -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

6
README.md

@ -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

@ -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

File diff suppressed because it is too large

0
doc/Enunciado - ProyectoSemestral.pdf → report/Enunciado - ProyectoSemestral.pdf

0
doc/Informe.tex → report/Informe.tex

0
doc/Makefile → report/Makefile

0
doc/code/builtins.txt → report/code/builtins.txt

0
doc/code/environ.txt → report/code/environ.txt

0
doc/code/launch.txt → report/code/launch.txt

0
doc/code/loop.txt → report/code/loop.txt

0
doc/code/redirection.txt → report/code/redirection.txt

0
doc/sections/codigo.tex → report/sections/codigo.tex

0
doc/sections/codigo/builtins.tex → report/sections/codigo/builtins.tex

0
doc/sections/codigo/ciclo.tex → report/sections/codigo/ciclo.tex

0
doc/sections/codigo/environ.tex → report/sections/codigo/environ.tex

0
doc/sections/codigo/permutar.tex → report/sections/codigo/permutar.tex

0
doc/sections/codigo/redireccion.tex → report/sections/codigo/redireccion.tex

0
doc/sections/conclusiones.tex → report/sections/conclusiones.tex

0
doc/sections/funcionamiento.tex → report/sections/funcionamiento.tex

0
doc/sections/introduccion.tex → report/sections/introduccion.tex

0
doc/ubblogo.png → report/ubblogo.png

Before

Width:  |  Height:  |  Size: 185 KiB

After

Width:  |  Height:  |  Size: 185 KiB

Loading…
Cancel
Save