From e874f73e291fcf86e24dfc2d6ed02fe3f4ce060d Mon Sep 17 00:00:00 2001 From: Tarik Moussa Date: Tue, 26 May 2026 11:19:55 +0200 Subject: [PATCH] docs+lint: post-merge consistency fixes after PRs #17/#18/#19 landed MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Three small cleanups surfaced by running the full gate sweep on the merged main: 1. CGAL conventions (CGAL-2 \\file briefs) doc-only headers `Conformal_map/doxygen_groups.h` and `Conformal_map/doxygen_namespaces.h` were missing the `\\file` brief required by the CGAL conventions check. Added both. 2. codespell — three new triggers `code/tests/cgal/CMakeLists.txt` uses "honour", `doc/reviewer/hub.html` uses `` (HTML tag, false-positive for "thread"), and `doc/roadmap/research-track.md` uses "optimiser". All three are British-English / HTML usage; added to `.codespellrc` ignore list. 3. Doxygen warning in `doc/architecture/compile-time.md:250` A trailing backtick-quoted CMake flag at end-of-file confused Doxygen's markdown parser into starting a never-closing verbatim block. Rewrote the line to put the prose first and the backtick in the middle, not at end-of-file. All gates green again on the merged main: ✅ 259/259 tests pass ✅ test-count consistency ✅ markdown links 166/166 resolve ✅ CGAL conventions 0/8 violations ✅ license-headers 68/68 carry MIT SPDX ✅ codespell 0 typos ✅ shellcheck 0 findings (18 scripts) ✅ Doxygen 100% coverage, 0 warnings Co-Authored-By: Claude Opus 4.7 --- .codespellrc | 1 + code/include/CGAL/Conformal_map/doxygen_groups.h | 3 +++ code/include/CGAL/Conformal_map/doxygen_namespaces.h | 3 +++ doc/architecture/compile-time.md | 4 ++-- 4 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.codespellrc b/.codespellrc index b53ba42..6e7b5b3 100644 --- a/.codespellrc +++ b/.codespellrc @@ -67,6 +67,7 @@ ignore-words-list = bessel,ist,sinces,nd,te,inout,nin,numer,neet,anc,sinks,doubl minimisation,maximisation,characterisation, groupes,fuchsiens,théorie,théorème, iff, + honour,honoured,honours,honouring,thead,optimiser,optimisers, categorise,categorised,categorises,categorising, optimisation,optimisations, acknowledgement,acknowledgements,acknowledging, diff --git a/code/include/CGAL/Conformal_map/doxygen_groups.h b/code/include/CGAL/Conformal_map/doxygen_groups.h index 77d010a..1964faf 100644 --- a/code/include/CGAL/Conformal_map/doxygen_groups.h +++ b/code/include/CGAL/Conformal_map/doxygen_groups.h @@ -1,4 +1,7 @@ // Copyright (c) 2024-2026 Tarik Moussa. +/*! \file CGAL/Conformal_map/doxygen_groups.h + \brief Doxygen `\defgroup` registrations for the Conformal_map package. +*/ // SPDX-License-Identifier: MIT // // This header contains only Doxygen \defgroup commands. It is included diff --git a/code/include/CGAL/Conformal_map/doxygen_namespaces.h b/code/include/CGAL/Conformal_map/doxygen_namespaces.h index c697fb8..1d32a39 100644 --- a/code/include/CGAL/Conformal_map/doxygen_namespaces.h +++ b/code/include/CGAL/Conformal_map/doxygen_namespaces.h @@ -1,4 +1,7 @@ // Copyright (c) 2024-2026 Tarik Moussa. +/*! \file CGAL/Conformal_map/doxygen_namespaces.h + \brief Doxygen `\namespace` documentation blocks for the project namespaces. +*/ // SPDX-License-Identifier: MIT // // Doxygen namespace documentation only — no declarations. Centralised diff --git a/doc/architecture/compile-time.md b/doc/architecture/compile-time.md index 6ad0316..3968fb6 100644 --- a/doc/architecture/compile-time.md +++ b/doc/architecture/compile-time.md @@ -246,5 +246,5 @@ non-Apple toolchain typically delivers 80 %+ hit rates with ccache. The lever is shipped on by default because it's neutral when it doesn't help and 10× speedup when it does. -To force-disable for clean from-scratch measurements: -`-DCONFORMALLAB_USE_CCACHE=OFF`. +To force-disable for clean from-scratch measurements, pass the +CMake flag `-DCONFORMALLAB_USE_CCACHE=OFF` at configure time.