add code documentation generation thanks to doxygen tool

このコミットが含まれているのは:
Antoine 2020-05-17 20:28:03 +02:00
コミット ca8dbad212
5個のファイルの変更2568行の追加4行の削除

2
.gitignore vendored
ファイルの表示

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

ファイルの表示

@ -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 ノーマルファイル
ファイルの表示

2553
doxygen.conf ノーマルファイル

ファイル差分が大きすぎるため省略します 差分を読み込み

ファイルの表示

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