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/doxygen
History
Exact
John Phelps 0b5b329d95 Developer Doxygen and BerliOS clean 
- Cleaned and Fixed developer Doxygen files
 - Added GitStats to the Dev Doxygen info
   -- run ./scripts/doxygen/gen_doxygen_docs.sh

 - Removed leftover refrences to BerliOS
 - Changed BerliOS links to Sourceforge links
2015-11-23 10:44:16 -06:00
..
fldigi_doxyfile.txt Doxygen for fldigi 2013-08-02 18:34:01 -05:00
gen_doxygen_docs.sh Developer Doxygen and BerliOS clean 2015-11-23 10:44:16 -06:00
readme.txt Doxygen for fldigi 2013-08-02 18:34:01 -05:00

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