Articles of kdoc

Markdown # vs multiple #

Noté que el uso de # o ## o #### es equivalente … ¿siempre será el caso? Solo quiero usar un '#' porque es más conveniente, siempre que no se convierta en text mucho más grande en el futuro. No estoy seguro de si esto se aplica a la documentation generada, ya que no sé […]

Dokka usa nombres de class completamente calificados

Estoy usando dokka para generar automáticamente javadoc para mí. Sin embargo, cuando encuentra cualquier class que no sea de mi proyecto utiliza nombres completos. ¿Es posible utilizar solo nombres de class y hacer que dokka proporcione un enlace para ello? Por ejemplo: java.lang.String getName() Me gustaría en lugar de java.lang.String tener String con un enlace […]

kotlin no resuelto enlace KDoc pero a IntelliJ no le gusta la import que lo arregla

import abc.MyClass.MyEnum; /// from Java /** * [MyClass.MyEnum] */ class efg () : MyClass.MyEnum { return MyClass.MyEnum.BiGNUMBER; } Tengo algo similar a lo anterior en IntelliJ … pero identificará la import como no utilizada , así que optimizar las importaciones lo eliminará … sin embargo, si no inserto esa import manualmente, entonces en mis documentos […]

¿Cómo vincular a un miembro estático de una class de Java en KDoc?

En KDoc, puedes hacer esto: /** * [Integer.equals] is an instance method. */ Pero no puedes hacer esto: /** * [Integer.signum] is a static method. */ Con "no se puede" me refiero a que IntelliJ IDEA no lo llevará a la statement de un miembro estático si utiliza Navigate → Declaration action en él. Navegar […]

¿Cuál es el nombre correcto para la documentation en línea de Kotlin?

Dado que el motor de generación de documentation de KDoc se abandona en favor de Dokka , ¿debería denominarse a la documentation de Kotlin como "comentarios de KDoc" o como "comentarios de Dokka"?

Kotlin KDoc: ¿Documentación?

He visto aquí , aquí y allá, references a KDoc, el equivalente de la utilidad JavaDoc para Kotlin. Sin embargo, no puedo encontrar ninguna documentation sobre cómo usarlo, y mucho less cómo personalizarlo o integrarlo en Maven o Gradle. Sé que el documento de la API de Kotlin se genera utilizando KDoc, ya que el […]

Copie los documentos de KDoc de un método a otro

Para los dos methods dados: /** * Adds a [DataItem] to the Android Wear network. The updated item is synchronized across all devices. */ fun putItem(){ …. } /** * "same KDOC here with above" */ fun putItem(putRequest: PutDataRequest){ …. } ¿Hay alguna posibilidad de copyr / vincular los documentos del segundo método para que […]

¿Dónde / Cómo se agrega documentation para los packages de Kotlin?

En Java, si desea documentar un package, debe colocarse en el file package-info.class. ¿Sigue siendo lo mismo con Kotlin y KDoc? Revisé algunas de las fonts de Kotlin y no puedo encontrar dónde está escrita la documentation de su package.

Cómo usar @link y @code en kotlin kDoc

Estoy intentando documentar un método e intentar usar @link y @code como en JavaDoc . Sé que en kotlin hay un kDoc pero no puedo encontrarlos o al less algo similar.

La documentation de Kotlin no admite tags como '<p>'.

Estoy escribiendo comentarios de doc para describir un método. /** * <p>necessary * <p>setType is to set the PendingIntend's request code</p> */ Pero no mostrará los párrafos. Si no uso <p> , toda la documentation está en una línea sin interrupción. Funciona en la class Java, pero cuando se trata de Kotlin, no sé cómo […]