| 1 |
# Doxyparse |
| 2 |
|
| 3 |
This directory contains an "source parsing engine" based on doxyapp code. |
| 4 |
|
| 5 |
Doxyparse modifies the default output of Doxygen and dumps the dependencies |
| 6 |
among code elements in a YAML format, instead of output it in a human-readable |
| 7 |
format, as Doxygen does Doxyparse's output is intended to produce a |
| 8 |
machine-readable output. |
| 9 |
|
| 10 |
Doxyparse has been used in many software engineering research (as a source-code |
| 11 |
static analysis tool) regards on software metrics, quality metrics and so on, |
| 12 |
Doxyparse was first used by the [Analizo](https://www.analizo.org) toolkit, a suite |
| 13 |
of source code analysis tools, aimed at being language-independent and |
| 14 |
extensible, able to extract and calculate a fair number of source code metrics, |
| 15 |
generate dependency graphs, and other software evolution analysis. |
| 16 |
|
| 17 |
Academic publications citing Doxyparse: |
| 18 |
* https://scholar.google.com.br/scholar?q=doxyparse |
| 19 |
|
| 20 |
## build dependencies |
| 21 |
|
| 22 |
apt-get install flex bison cmake build-essential python |
| 23 |
|
| 24 |
## build |
| 25 |
|
| 26 |
cmake -G "Unix Makefiles" -Dbuild_parse=ON |
| 27 |
make |
| 28 |
|
| 29 |
## install |
| 30 |
|
| 31 |
sudo make install |
| 32 |
|
| 33 |
## release |
| 34 |
|
| 35 |
* ensure analizo testsuite passing on newer doxyparse version |
| 36 |
* update debian/changelog, commit, push |
| 37 |
* create git tag, push to github analizo/doxyparse |
| 38 |
* build on amd64 and i386 archs, upload tar.gz to github |
| 39 |
* `tar -zcf doxyparse_<VERSION>_amd64.tar.gz -C bin/ doxyparse` |
| 40 |
* `tar -zcf doxyparse_<VERSION>_i386.tar.gz -C bin/ doxyparse` |
| 41 |
* build debian packages for amd64 and i386, update analizo.org repository |
| 42 |
* (see analizo.github.io/README.md file for updating repository instructions) |
| 43 |
* upload the deb files to github release tag also |
| 44 |
* check if a alien-doxyparse release is necessary and do it on cpan |
| 45 |
|
| 46 |
## Authors |
| 47 |
|
| 48 |
* Antonio Terceiro <[email protected]> |
| 49 |
* João M. Miranda <[email protected]> |
| 50 |
* Joenio Costa <[email protected]> |
| 51 |
* Paulo Meirelles <[email protected]> |
| 52 |
* Vinicius Daros <[email protected]> |