From abab1ca40750c038b69f112f94f591cc3ea07648 Mon Sep 17 00:00:00 2001 From: Joenio Marques da Costa Date: Tue, 1 Dec 2020 20:44:26 +0100 Subject: better description of Doxyparse on README doc closes analizo/analizo#169 --- addon/doxyparse/README | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/addon/doxyparse/README b/addon/doxyparse/README index 95cce8c..75746b7 100644 --- a/addon/doxyparse/README +++ b/addon/doxyparse/README @@ -1,22 +1,34 @@ -doxyparse -========= +# Doxyparse This directory contains an "source parsing engine" based on doxyapp code. -More info and source code repository: https://github.com/analizo/doxygen +Doxyparse modifies the default output of Doxygen and dumps the dependencies +among code elements in a YAML format, instead of output it in a human-readable +format, as Doxygen does Doxyparse's output is intented to produce a +machine-readable output. + +Doxyparse has been used in many software engeneering research (as a source-code +static analysis tool) regards on software metrics, quality metrics and so on, +Doxyparse was first used by the [Analizo](http://analizo.org) toolkit, a suite +of source code analysis tools, aimed at being language-independent and +extensible, able to extract and calculate a fair number of source code metrics, +generate dependency graphs, and other software evolution analysis. + +Academic publications citing Doxyparse: +* https://scholar.google.com.br/scholar?q=doxyparse ## build dependencies - apt-get install flex bison cmake build-essential python + apt-get install flex bison cmake build-essential python ## build - cmake -G "Unix Makefiles" -Dbuild_parse=ON - make + cmake -G "Unix Makefiles" -Dbuild_parse=ON + make ## install - sudo make install + sudo make install ## release @@ -31,10 +43,10 @@ More info and source code repository: https://github.com/analizo/doxygen * upload the deb files to github release tag also * check if a alien-doxyparse release is necessary and do it on cpan -AUTHORS +## Authors -Antonio Terceiro -João M. Miranda -Joenio Costa -Paulo Meirelles -Vinicius Daros +* Antonio Terceiro +* João M. Miranda +* Joenio Costa +* Paulo Meirelles +* Vinicius Daros -- cgit v0.12