From 2ea071dc913891408074f087c932e23260e6a395 Mon Sep 17 00:00:00 2001
From: Yashas Ambati <yashas.amb@gmail.com>
Date: Thu, 3 Apr 2025 14:58:43 -0400
Subject: [PATCH] Comment for doxygen variables

---
 doc/CMakeLists.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index ba3d75e90..8d4692fdb 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -8,7 +8,8 @@ option(GTSAM_GENERATE_DOC_XML            "Enable/Disable doxygen XML output"
 
 # add a target to generate API documentation with Doxygen
 if (GTSAM_BUILD_DOCS)
-    # Convert configuration to YES/NO variables
+    # The following if statements convert ON/OFF CMake flags to YES/NO variables
+    # since Doxygen expects YES/NO for boolean options.
     if (GTSAM_BUILD_DOC_HTML)
         set(GTSAM_BUILD_DOC_HTML_YN "YES")
     else()