"com.foo.Bar $ toString()"에 대한 문서가 없음에 대한 Dokka의 불만을 표시하지 않습니까?

Question

일부 Kotlin 코드에 대한 설명서를 생성하기 위해 Gradle Dokka 플러그인 버전 0.9.16-eap-1을 사용하고 있습니다.

나는 깨진 창문이 아니기 때문에, 기본 클래스 인 에 명시 적으로 문서화 된 재정의 된 메소드를 명시 적으로 문서화하지 않은 클래스에 대해 플러그인이 1 톤의 메시지를 생성한다는 사실에 다소 좌절감을 느낍니다. 예를 들어 :

No documentation for com.foo.Bar$read() (Bar.kt:6) 
No documentation for com.foo.Bar$toString() (Bar.kt:7) 

내가 중복 중복으로 모든 것을 문서화하고 싶지 않기 때문에 이것은 약간 지루 :이 클래스 Dokka의 징계에 대한

package com.foo 
/** 
* A silly class to demonstrate silliness. 
*/ 
class Bar : java.io.InputStream() { 
    override fun read() = -1 
    override fun toString() = "BAZ!" 
} 

복사 - 붙여 넣기 문서.

dokka { 
    ... 
    // Emit warnings about not documented members. Applies globally, also can be overridden by packageOptions 
    reportNotDocumented = true 
    ... 
    // Allows to customize documentation generation options on a per-package basis 
    // Repeat for multiple packageOptions 
    packageOptions { 
     ... 
     reportUndocumented = true // Emit warnings about not documented members 
     ... 
    } 
} 

하지만 문서화되지 않은 물건에 대한 경고를 억제하지 않으려는 다음 Dokka README.md 보면

는

, 내가 볼 수있는 유일한 관련 구성 옵션이 있습니다. 그건 나쁘지 않을거야. 내가하고 싶은 것은 문서화되지 않은 것에 대한 경고를 억제하는 것이다. 나는 의도적으로 나 자신을 되풀이하지 않고 반복적으로 반복하지 않는다는 것에 대한 재미를 override에있다.

override fun에 대한 경고를 끄는 옵션이 있는지 아는 사람이 있습니까?

특정 경우에 사용하기 위해

Answer 1

@suppress 완전히 문서에서 오버라이드 (override) 기능을 제외됩니다

class MyAndroidActivity: Activity { 

    /** @suppress */ 
    override fun onCreate(savedInstanceState: Bundle?) { 
     ... 
    } 

} 

이 방법. 이 설명서의 API 호출에 대한 참조를 유지하려면

그러나, 단순히 요소에 가까운 문서화 문자열 온라인 빈을 추가 (이 경고를 비활성화됩니다) :

class MyAndroidActivity: Activity { 

    /***/ 
    override fun onCreate(savedInstanceState: Bundle?) { 
     ... 
    } 

}