From e277b08a26e19352771824ce79de26d0776f3fe6 Mon Sep 17 00:00:00 2001 From: jespergravgaard Date: Sat, 19 Jun 2021 22:37:48 +0200 Subject: [PATCH] Improved doxygen documentation. Closes #672 --- Makefile | 3 +++ src/main/kc/include/atan2.h | 1 + src/main/kc/include/c128.h | 1 + 3 files changed, 5 insertions(+) diff --git a/Makefile b/Makefile index 535e3ec7c..d73c01e53 100644 --- a/Makefile +++ b/Makefile @@ -4,4 +4,7 @@ test: mvn package clean: mvn clean +doxygen: + mkdir target + doxygen src/main/doxygen/doxygen.conf diff --git a/src/main/kc/include/atan2.h b/src/main/kc/include/atan2.h index 2110b3a76..6b99606cf 100644 --- a/src/main/kc/include/atan2.h +++ b/src/main/kc/include/atan2.h @@ -1,5 +1,6 @@ /// @file /// Find atan2(x, y) using the CORDIC method +/// /// See http://bsvi.ru/uploads/CORDIC--_10EBA/cordic.pdf /// Find the atan2(x, y) - which is the angle of the line from (0,0) to (x,y) diff --git a/src/main/kc/include/c128.h b/src/main/kc/include/c128.h index 2c54250b1..f23967634 100644 --- a/src/main/kc/include/c128.h +++ b/src/main/kc/include/c128.h @@ -1,5 +1,6 @@ /// @file /// Commodore 128 Registers and Memory +/// /// https://archive.org/details/C128_Programmers_Reference_Guide_1986_Bamtam_Books/page/n299/mode/2up #ifndef __C128__ #error "Target platform must be C128"