Skip to content

docs(mindrecord,receiver): 끊긴 KDoc 링크 2건 인계 — 담당 모듈이 달라 #1783 에서 분리 #1784

Closed

Description

@OnlyReadOneBook

작업 유형

documentation — 문서

주 담당 모듈

mindrecord — 마음의 기록

개요

인계 사유

#1783 에서 저장소 전역의 해석되지 않는 KDoc FQN 링크 30건을 전수 스캔으로 찾아 정정하는데, 그중 2건이 담당이 다른 모듈의 프로덕션 파일이라 이 이슈로 넘긴다. 나머지 28건은 #1776·#1783 에서 처리한다.

두 건 모두 KDoc 주석 한 줄이고 동작 변경은 없다.

대상 2건

1. feature:mindrecord — 평탄화(#1092) 잔재

feature/mindrecord/presentation/src/main/kotlin/com/afternote/feature/mindrecord/presentation/navigation/MindRecordNavActions.kt:7

[com.afternote.feature.afternote.presentation.author.navigation.AfternoteNavActions]

author. 세그먼트를 걷어내면 된다. 실제 선언은 feature/afternote/.../presentation/navigation/AfternoteNavActions.kt:15.

[com.afternote.feature.afternote.presentation.navigation.AfternoteNavActions]

2. 수신자 홈 — 모듈 이관(#1461) 잔재

feature/receiver/presentation/src/main/kotlin/com/afternote/feature/receiver/presentation/home/ReceiverHomeViewModel.kt:57

[com.afternote.feature.receiver.presentation.detail.ReceivedAfternoteDetailViewModel]

feature/receiver/presentation 에는 detail 패키지가 없다. ReceivedAfternoteDetailViewModel 은 #1461 로 afternote 모듈로 옮겨졌고, 실제 선언은 feature/afternote/presentation/.../receiver/detail/ReceivedAfternoteDetailViewModel.kt:35.

[com.afternote.feature.afternote.presentation.receiver.detail.ReceivedAfternoteDetailViewModel]

왜 게이트가 못 잡았나

KDoc 의 [com.foo.Bar] 링크는 해석에 실패해도 컴파일 에러가 아니다. 컴파일·ktlint·Konsist 어느 것도 이 부류를 보지 못한다. 실제 손실은 IDE 문서 팝업에서 Ctrl+클릭이 죽는 것 하나이고, 이 저장소는 Dokka 를 쓰지 않으므로 생성 문서 쪽 영향은 없다. 급한 건이 아니다.

참고

Metadata

Metadata

Assignees

Labels

area:mindrecord마음의 기록 기능 영역documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions