1cb93a386Sopenharmony_ciDoxygen 2cb93a386Sopenharmony_ci======= 3cb93a386Sopenharmony_ci 4cb93a386Sopenharmony_ciTo generate all the documentation run the following 5cb93a386Sopenharmony_cifrom this directory: 6cb93a386Sopenharmony_ci 7cb93a386Sopenharmony_ci doxygen Doxyfile 8cb93a386Sopenharmony_ci 9cb93a386Sopenharmony_ciThe resulting output goes to 10cb93a386Sopenharmony_ci 11cb93a386Sopenharmony_ci /tmp/doxygen 12cb93a386Sopenharmony_ci 13cb93a386Sopenharmony_ciTo view those file locally in your browser run: 14cb93a386Sopenharmony_ci 15cb93a386Sopenharmony_ci cd /tmp/doxygen/html; python -m SimpleHTTPServer 8000 16cb93a386Sopenharmony_ci 17cb93a386Sopenharmony_ciand visit 18cb93a386Sopenharmony_ci 19cb93a386Sopenharmony_ci http://localhost:8000 20cb93a386Sopenharmony_ci 21cb93a386Sopenharmony_ciIf you want to have the documentation regenerated on every save then 22cb93a386Sopenharmony_ciyou can install `entr` and run the following from this directory: 23cb93a386Sopenharmony_ci 24cb93a386Sopenharmony_ci find ../../include/ ../../src/ . | entr doxygen ./Doxyfile 25cb93a386Sopenharmony_ci 26cb93a386Sopenharmony_ciInstall 27cb93a386Sopenharmony_ci------- 28cb93a386Sopenharmony_ci 29cb93a386Sopenharmony_ciFor a linux desktop you can install the doxygen tool via: 30cb93a386Sopenharmony_ci 31cb93a386Sopenharmony_ci sudo apt install doxygen 32