nmelone/GoldenCheetah
1
0
Fork 0
mirror of https://github.com/GoldenCheetah/GoldenCheetah.git synced 2026-02-13 16:18:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use doxygen to generate code documentation

Browse Source 
.. run make in src/doc/doxygen to generate documentation for the
   source code in html and latex format.

.. doing this to get some basic docs going, since the codebase is
   now so large its getting difficult for even the core team to
   remember.

.. the subdirectories generated are ignored (see .gitignore)

[skip ci]
This commit is contained in:
Mark Liversedge
2021-10-05 09:53:28 +01:00
parent fab0c1aae4
commit 09e2ac95da
3 changed files with 2662 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@@ -36,6 +36,8 @@ plugins/
resources/
src/debug/
src/release/
doc/doxygen/latex
doc/doxygen/html
qwt/src/debug/
qwt/src/release/

2658
doc/doxygen/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

2
doc/doxygen/Makefile Normal file
View File

@@ -0,0 +1,2 @@
dummy:
doxygen Doxyfile