Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.44 KB

JavaDoc comments.md

File metadata and controls

25 lines (18 loc) · 1.44 KB
Raw

JavaDoc comments

Статус Ожидание Реальность
⚠️ Комментарии видны в XCode Комментарии видны, если добавить специальный аргумент для компилятора

С Kotlin 1.5.20 есть возможность пробрасывать JavaDoc комментарии. Для этого нужно включить генерацию комментариев в настройке multiplatform-модуля:

kotlin {

    targets.withType<org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget> { 
        // Для включения документации  
        compilations["main"].kotlinOptions.freeCompilerArgs += "-Xexport-kdoc"  
    }

}

После этого на стороне XCode-а в автодополнениях можно видеть комментарии к классу и методам. Если переходить к определению функций (в .h-файл), то можно увидеть комментарии к @param / @return и т.д.

Оглавление