wallet-core icon indicating copy to clipboard operation
wallet-core copied to clipboard

[Kotlin] Codegen API doc from C headers

Open hewigovens opened this issue 2 years ago • 3 comments

Dokka https://github.com/Kotlin/dokka

hewigovens avatar May 16 '22 08:05 hewigovens

Most non-test swift code is generated, so codegen logic has to be extended to:

  • read descriptions from source files (TW*.h)
  • generate documentation comments in a common format, understood by documenting tool

optout21 avatar May 25 '22 13:05 optout21

@Milerius can you update your finding here?

hewigovens avatar Sep 22 '22 03:09 hewigovens

@Milerius can you update your finding here?

Kotlin comments use Asterix style: https://kotlinlang.org/docs/kotlin-doc.html

We need to find a good way with a script similar to the swift one to convert the /// doxygen comments into Kotlin one. I suggest to use sed or perl with regex once again

Milerius avatar Sep 22 '22 14:09 Milerius

Implemented in #2678

Milerius avatar Dec 06 '22 08:12 Milerius