docs: clean Doxygen warning log (0 warnings) + flag honest gaps to reviewer
Doxygen now builds with **0 warnings** (was 27). Root cause: `[label](doc/api/tests.md)`-style relative markdown links in README.md and CLAUDE.md were being interpreted by Doxygen as \ref commands and failed to resolve (Doxygen indexes .md files by basename, not by repo-relative path). Fix: add a per-file `FILTER_PATTERNS` to Doxyfile that rewrites `[label](path/to/file.md)` into `<a href="path/to/file.md">label</a>` just for Doxygen. HTML anchors bypass \ref resolution entirely; the generated Doxygen HTML still hyperlinks correctly. The on-disk markdown is untouched, so GitHub rendering is unaffected. New file: scripts/doxygen-md-filter.sh (24 lines, documented). Also: append a "Known limitations (state at the time of the reviewer meeting)" table to doc/architecture/locked-vs-flexible.md so the external reviewer sees the 7 deliberate gaps (output_uv_map covers 3 of 5 entries; pipe-only chaining; Phase 9b-analytic derived but not implemented; Doxygen WARN_IF_UNDOCUMENTED policy; CI test-count gate; research-track utilities) with effort estimates next to each. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
6
Doxyfile
6
Doxyfile
@@ -34,6 +34,12 @@ EXCLUDE_PATTERNS = */build*/* \
|
||||
*/* 2.hpp
|
||||
EXCLUDE_SYMBOLS = Eigen::* boost::* std::*
|
||||
|
||||
# Markdown filter: rewrites repo-relative links like [x](doc/api/tests.md)
|
||||
# into basename-only links [x](tests.md) so Doxygen's basename-indexed
|
||||
# \ref resolver can find them. On-disk files are untouched (GitHub keeps
|
||||
# rendering them correctly). See scripts/doxygen-md-filter.sh.
|
||||
FILTER_PATTERNS = *.md=scripts/doxygen-md-filter.sh
|
||||
|
||||
# ── Source browsing ──────────────────────────────────────────────────────────
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_PRIVATE = NO
|
||||
|
||||
Reference in New Issue
Block a user