Browse Source

add code documentation generation thanks to doxygen tool

master
Antoine 1 year ago
parent
commit
ca8dbad212
5 changed files with 2568 additions and 4 deletions
  1. +2
    -0
      .gitignore
  2. +7
    -2
      Makefile
  3. +0
    -0
      doc/.empty
  4. +2553
    -0
      doxygen.conf
  5. +6
    -2
      readme.md

+ 2
- 0
.gitignore View File

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

data/*/*
!data/*/file
*.o


+ 7
- 2
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
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
- 0
doc/.empty View File


+ 2553
- 0
doxygen.conf
File diff suppressed because it is too large
View File


+ 6
- 2
readme.md View File

@@ -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…
Cancel
Save