add code documentation generation thanks to doxygen tool
This commit is contained in:
parent
f2793e5a02
commit
ca8dbad212
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,7 +1,9 @@
|
||||
# project specific
|
||||
bin/*
|
||||
obj/*
|
||||
doc/*
|
||||
!.empty
|
||||
|
||||
data/*/*
|
||||
!data/*/file
|
||||
*.o
|
||||
|
9
Makefile
9
Makefile
@ -1,4 +1,4 @@
|
||||
.PHONY: cryptomain.ex crypt.ex decrypt.ex
|
||||
.PHONY: cryptomain.ex crypt.ex decrypt.ex doxygenconf
|
||||
|
||||
GCXX_DEBUG=-ggdb
|
||||
CFLAGS=-Wall -Wextra --std=c++14 $(GCXX_DEBUG)
|
||||
@ -66,6 +66,11 @@ cleanD:
|
||||
@rm -f data/*.dec
|
||||
@rm -f data/*.key
|
||||
|
||||
doc:
|
||||
markdown:
|
||||
@pandoc --defaults=pandocConfig.yaml
|
||||
|
||||
doxygenconf:
|
||||
@doxygen -g doxygen.conf
|
||||
|
||||
doc: doxygen.conf
|
||||
@doxygen doxygen.conf
|
||||
|
0
doc/.empty
Normal file
0
doc/.empty
Normal file
2553
doxygen.conf
Normal file
2553
doxygen.conf
Normal file
File diff suppressed because it is too large
Load Diff
@ -15,8 +15,12 @@
|
||||
|
||||
## 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`
|
||||
|
||||
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
|
||||
|
Loading…
Reference in New Issue
Block a user