Skip to content

Cradle 공개 API Quick Help 문서를 구성한다 - #44

Merged
opficdev merged 3 commits into
developfrom
docs/#43
Sep 6, 2026
Merged

opficdev merged 3 commits into
developfrom
docs/#43

Conversation

@opficdev

@opficdev opficdev commented Sep 6, 2026

Copy link
Copy Markdown
Owner

🔗 연관된 이슈

🎯 작업 목적

Cradle 고유 공개 API 16개의 핵심 계약을 Xcode 26.5 Quick Help에서 확인할 수 있는 문서 제공

공개 API 선언, Macro 동작, 런타임 동작, 테스트 동작을 변경하지 않는 문서 범위 유지

📝 작업 내용

📌 요약

  • 공개 API 16개에 /** ... */ 문서 블록 추가
  • Parameters, Important, Note, Warning 필드 구성
  • DependencyGraph, DependencyGraphLifetime, DependencyLifetime, DependencyOverride, External 문서화
  • Xcode 26.5 Quick Help에서 동작하지 않는 SeeAlso 16개 제거
  • 기존 DependencyGraph.md와 공개 API 선언 시그니처 유지

🔍 상세

  • @DependencyGraph의 적용 대상과 lifetime, sources, overrides, diagram 매개변수 문서화
  • @Provide의 기본 수명과 .shared, .lazy, .transient 평가 시점 문서화
  • DependencyGraphLifetime과 DependencyLifetime의 책임 구분
  • @External의 호출 시점 입력과 .transient 전용 제약 문서화
  • DependencyOverride의 원본·교체 Factory 선택 범위 문서화
  • 첫 문단을 Summary로 사용하고 실제 Swift 선언을 Declaration으로 표시하는 Quick Help 구성
  • Xcode 26.5 실제 확인 결과에 따른 /// 문서 주석 방식 교체와 동작하지 않는 SeeAlso 제거

@opficdev opficdev self-assigned this Sep 6, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 6, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-06T16:29:02.317191Z 0d4a4fa PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@opficdev opficdev changed the title Cradle 공개 API Quick Help와 상세 DocC 연결을 구성한다 Cradle 공개 API Quick Help 문서를 구성한다 Sep 6, 2026
@opficdev
opficdev merged commit 4d15192 into develop Sep 6, 2026
5 checks passed
@opficdev
opficdev deleted the docs/#43 branch September 6, 2026 16:34
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.

Cradle 공개 API Quick Help 문서를 구성한다

1 participant