C/aes
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add code documentation generation thanks to doxygen tool

Browse Source
This commit is contained in:
Antoine 2020-05-17 20:28:03 +02:00
parent f2793e5a02
commit ca8dbad212
5 changed files with 2568 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,7 +1,9 @@
# project specific # project specific
bin/* bin/*
obj/* obj/*
doc/*
!.empty !.empty
data/*/* data/*/*
!data/*/file !data/*/file
*.o *.o

9
Makefile
View File

@ -1,4 +1,4 @@
.PHONY: cryptomain.ex crypt.ex decrypt.ex .PHONY: cryptomain.ex crypt.ex decrypt.ex doxygenconf
GCXX_DEBUG=-ggdb GCXX_DEBUG=-ggdb
CFLAGS=-Wall -Wextra --std=c++14 $(GCXX_DEBUG) CFLAGS=-Wall -Wextra --std=c++14 $(GCXX_DEBUG)
@ -66,6 +66,11 @@ cleanD:
@rm -f data/*.dec @rm -f data/*.dec
@rm -f data/*.key @rm -f data/*.key
doc: markdown:
@pandoc --defaults=pandocConfig.yaml @pandoc --defaults=pandocConfig.yaml
doxygenconf:
@doxygen -g doxygen.conf
doc: doxygen.conf
@doxygen doxygen.conf

0
doc/.empty Normal file
View File

2553
doxygen.conf Normal file
View File

File diff suppressed because it is too large Load Diff

8
readme.md
View File

@ -15,8 +15,12 @@
## requirements ## requirements
this program required jsoncpp : https://github.com/open-source-parsers/jsoncpp * this program required jsoncpp : https://github.com/open-source-parsers/jsoncpp
> archlinux setup : `pacman -S jsoncpp` > archlinux setup : `pacman -S jsoncpp`
gcc lib flag are retrieve thanks to [pkg-config](https://people.freedesktop.org/~dbn/pkg-config-guide.html) tool * gcc lib flag are retrieve thanks to [pkg-config](https://people.freedesktop.org/~dbn/pkg-config-guide.html) tool
* cpp documentation is generated thanks to [doxygen](http://www.doxygen.nl/manual/doxygen_usage.html)
> use make doc to generate doxygen documentation