KDoc-er

Install from plugin store

Introducing A simple and lightweight KDoc generator.

KDoc is a language used to document the Kotlin codes. And this plugin helps to generate smart KDoc for your project.

This plugin is very lightweight and efficient for generating KDoc for Kotlin files.

What's New

Version 1.0

1. Support for Kotlin file, Class, function, extension function, and receivers
2. Generate KDoc for all elements in a file
3. Generate KDoc for a single element
4. Remove KDoc for all elements in a file
5. Remove KDoc for a single elements
6. Type /** and tap enter, and the plugin will create KDoc for the particular element
7. Simple access from Generate menu. Tap Alt+ Insert, there is KDocer submenu
8. Also available on Code Format group in Code menu

You can read the Official Documentation to familiarize yourself with the KDoc syntax

Note

This plugin will not create KDoc HTML previews and additional files. This plugin is intended only for generating KDoc inside the IDE terminal.

For generating HTML document you can use the Dokka plugin available at Github.

This plugin is available on Jetbrains plugin repository.

Contribute?

All types of contributions are welcome. Please clone and change the code and make a PR.

Install and spread the word :)