ham-ref/fldigi
1
0
Fork 0
mirror of https://git.code.sf.net/p/fldigi/fldigi synced 2026-08-13 17:47:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
fldigi/scripts/srcdoc
History
Exact
John Phelps 9bcfdb2122 Updated Doxygen Sourcecode Docs 
* Now renders to SVG for graphics (doxygen 1.18)
 * Fixed scripts for Cppcheck 1.9 changes
 * Added auto-installer for packages on Debian-like systems
 * Improved main page: index.html
2020-10-30 15:56:30 -05:00
..
fldigi_doxyfile.txt Updated Doxygen Sourcecode Docs 2020-10-30 15:56:30 -05:00
gen_doxygen_srcdoc.sh Updated Doxygen Sourcecode Docs 2020-10-30 15:56:30 -05:00
readme.txt Updated Doxygen Sourcecode Docs 2020-10-30 15:56:30 -05:00

readme.txt 

/scripts/srcdoc/readme.txt

This directory contains the script: gen_doxygen_srcdoc.sh
and the configuration file: fldigi_doxyfile.txt
used for auto-generating interactive HTML DOXYGEN source-code documentation.

Unless disabled, the tool CPPcheck is also ran.

This documentation can be extremely useful for 
both learning and debugging fldigi/flarq.


== Preparation ==

 * Install the programs: 
	- cppcheck, graphviz, doxygen, mscgen
	
 * On a Debian based system (Ubuntu, Mint, etc) install required binaries by running:
	-  ./gen_doxygen_srcdoc.sh install

	
== Generating the Sourcecode Documentation ==

 * Execute:
	-  ./gen_doxygen_srcdoc.sh run 
	( the script will complain usefully if any needed binaries are missing )
	NOTE: this will generate over 700MB of data and take much longer than compilation!

 * Once generation completes, the source documentation can be accessed at:  
	- HTML/index.html

	
== Generate Source Documentation Without CppCheck ==

 * Execute:
	-  ./gen_doxygen_srcdoc.sh run nocppcheck

 
== Cleanup ==
 
 * Execute:
	-  ./gen_doxygen_srcdoc.sh clean