kopia lustrzana https://github.com/jamescoxon/dl-fldigi
989a11136b
* Added scripts to generate Doxygen documentation from fldigi git repository / source * Also executes "cppcheck" and includes those results on Doxygen page (if installed on system) * Generates patches and log for the last 125 commits: includes links on Doxygen page |
||
---|---|---|
.. | ||
fldigi_doxyfile.txt | ||
gen_doxygen_docs.sh | ||
readme.txt |
readme.txt
scripts/doxygen/readme.txt This directory contains the run-script: gen_doxygen_docs.sh and configuration file: fldigi_doxyfile.txt used for auto-generating DOXYGEN source-code documentation. This documentation can be extremely useful for both learning and debugging fldigi/flarq. == Usage == 1) Execute: ' ./gen_doxygen_docs.sh run ' on a Unix-Like system. (OSX, Linux, etc...) - the script will complain usefully if anything is missing - NOTE: this will generate 1.8GiB of data and take longer than compilation. 2) Once generation completes, a web-browser will automatically open the file: HTML/index.html - URL Example: file:///tmp/fldigi/scripts/doxygen/HTML/index.html