conformallab/ConformalLabpp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs+lint: post-merge consistency fixes after PRs #17/#18/#19 landed

Browse Source 
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 `<thead>` (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 <noreply@anthropic.com>
This commit is contained in:
Tarik Moussa
2026-05-26 11:19:55 +02:00
parent 3953d1549b
commit e874f73e29
4 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
code/include/CGAL/Conformal_map/doxygen_groups.h
View File

@@ -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

3
code/include/CGAL/Conformal_map/doxygen_namespaces.h
View File

@@ -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