Skip to content

fix(doc): point doxygen INPUT at the fetched stela and indep sources - #63

Merged
kniz merged 1 commit into
mainfrom
fix/doxygen-input-paths
Sep 5, 2026
Merged

kniz merged 1 commit into
mainfrom
fix/doxygen-input-paths

Conversation

@kniz

@kniz kniz commented Sep 4, 2026

Copy link
Copy Markdown
Member

문제

build/DoxyReference-ko / -en 의 INPUT 이 아직도 아래 경로들을 가리키고 있습니다.

../module/clog
../module/indep
../module/memlite
../module/meta
../module/stela

이 다섯 모듈은 stela / indep 저장소로 분리되어 나갔기 때문에 이 저장소에는 존재하지 않습니다. 현재 byeol/module/ 에 남아 있는 것은 core, frontend, bundle, test 뿐입니다.

Doxygen은 없는 INPUT 디렉토리를 경고만 내고 넘어가므로, 그동안 레퍼런스 사이트가 조용히 다음 상태로 빌드되고 있었습니다.

  • clog / indep / meta / memlite / stela 의 API 페이지가 하나도 생성되지 않음
  • 그 결과 aj-architecture-stela.md 를 비롯한 아키텍처 문서의 @ref by::stela, @ref by::valStela, @ref by::stelaParser 링크가 전부 dangling

수정

FetchContent 가 받아오는 실제 위치로 INPUT 을 돌렸습니다.

  • stela: _deps/stela_dep-src/module/{clog,meta,memlite,stela}
  • indep: _deps/indep_dep-src/module/indep (indep은 stela에서 다시 분리되어 별도 저장소이므로 base dir이 다릅니다)

경로는 기존 doxygen, ../doc/ref/ko 항목과 동일하게 build/ 기준 상대경로입니다. 나열 순서는 아키텍처 문서의 계층 순서(indep → clog → meta → memlite → stela → core → frontend)에 맞췄습니다.

검증

_deps 를 채운 뒤 DoxyReference-ko 를 실제로 돌려 확인했습니다.

  • by:: 클래스 페이지 705개 생성 (수정 전에는 core/frontend 분량만)
  • arrStela, defStela, strStela, valStela, verStela, nulStela, stelaParser, stelaWriter, stelaVisitInfo 페이지 생성 확인
  • aj-architecture-stela.html 의 @ref by::stela 가 classby_1_1stela.html 로 정상 링크됨

남은 것 (이 PR 범위 밖)

  • builder.py doc 은 빌드를 하지 않으므로 _deps 가 비어 있으면 여전히 API 페이지가 비어 나옵니다. 문서 생성 전에 빌드가 선행되어야 하고, 이를 doc() 이 보장하도록 할지는 별도 판단이 필요해 보입니다.
  • stelaVisitor 와 core의 visitor 는 클래스 본문 안에서 visitee.inl 을 #include 하는 X-macro 패턴 때문에 Doxygen이 클래스로 잡지 못합니다. 이 PR 이전부터 있던 문제이고 stela 전용도 아니라 손대지 않았습니다.
  • EXCLUDE = ../mods/unittest 도 존재하지 않는 경로입니다. 무해해서 그대로 뒀습니다.

https://claude.ai/code/session_01SYqFWgKvvCf4untQ9sGvDQ

The clog, indep, meta, memlite and stela modules moved out of this
repository, but DoxyReference-ko/-en kept listing them under ../module,
so the reference build silently produced no API pages for any of them
and every @ref by::stela link in the architecture documents dangled.

FetchContent puts them under the build directory, so point INPUT there
instead. The paths are relative to build/, matching the existing
doxygen and ../doc/ref entries. Run a build before builder.py doc so
_deps is populated.

Claude-Session: https://claude.ai/code/session_01SYqFWgKvvCf4untQ9sGvDQ

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fb928b3b09

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread build/DoxyReference-en
Comment on lines +818 to +822
_deps/indep_dep-src/module/indep \
_deps/stela_dep-src/module/clog \
_deps/stela_dep-src/module/meta \
_deps/stela_dep-src/module/memlite \
_deps/stela_dep-src/module/stela \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Populate fetched sources before generating reference docs

The production publish-doc job checks out a clean tree and then runs only builder.py doc (.github/workflows/ci-main.yml lines 584-585 and 633-639). That command invokes Doxygen without configuring CMake (build/builder.py lines 227-237), while these _deps directories are created only by FetchContent_MakeAvailable(stela_dep) during CMake configuration (module/core/CMakeLists.txt lines 8-13). Consequently both newly added input directories are absent on every documentation-publishing run, so Doxygen continues to omit the stela/indep API pages this change is intended to restore. Make the doc workflow/command populate the dependencies first, or fetch them independently before Doxygen runs.

Useful? React with 👍 / 👎.

@codecov

codecov Bot commented Sep 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kniz
kniz merged commit 10b8cbc into main Sep 5, 2026
10 checks passed
@kniz
kniz deleted the fix/doxygen-input-paths branch September 5, 2026 15:00
kniz added a commit that referenced this pull request Sep 6, 2026
The reference INPUT points at _deps/{stela,indep}_dep-src, which only CMake FetchContent creates at configure time. doc ran doxygen without configuring, so the clean publish-doc runner had neither directory and the stela/indep API pages stayed empty despite #63's path fix. doc() now configures once (skipping when _deps already exists) so the fetched sources are present.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant