2017-04-23 9 views
2

일종의 클릭 수신기를 등록하는 고차 함수가 있다고 가정 해 보겠습니다. 나는 그것의 목적과 같이에서 전달되는 listener 매개 변수를 문서화 할 수 있습니다Kotlin의 함수 매개 변수 매개 변수 문서화

/** 
* Adds a [listener] that's called when the item is clicked. 
* 
* @param listener The listener to add 
*/ 
fun addClickListener(listener: (count: Int) -> Unit) { 
    ... 
} 

내 질문이있는 listener의 매개 변수를 문서화하는 방법이 있나요? 이 예제에서는 count입니다. 실제로 사용하는 경우에는 청취자에 여러 매개 변수가 있습니다.

제가 알아챈 점은이 기능을 사용하는 문서 뷰에서 [listener] 텍스트를 클릭 할 수 있다는 것입니다.하지만 빈 대화 상자가 표시됩니다. 여하튼 매개 변수를 설명하는 방법이 있습니까?

enter image description here The listener documentation that comes up

는 지금, 나는 addClickListener 방법에 @param 블록에 리스너의 매개 변수를 설명하는 결국했지만, 이것은 IDE에 경고를 초래하고,이 있는지 궁금하네요 그것을하는 더 적당한 방법.

답변

5

Kotlin 1.1부터는 함수 매개 변수로 사용되는 함수 유형의 매개 변수 또는 반환 값을 문서화하는 구문이 없습니다. 이를 다루는 open YouTrack issue이 있습니다.