Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zxj5470/bugkotlindocument

Plugin for IntelliJ IDEA ┗😃┛ Android Studio ┗😃┛ CLion ┗😃┛ AppCode.
https://github.com/zxj5470/bugkotlindocument

android-studio appcode clion comments documentation intellij intellij-plugin jetbrains-plugin kotlin plugin

Last synced: 3 months ago
JSON representation

Plugin for IntelliJ IDEA ┗😃┛ Android Studio ┗😃┛ CLion ┗😃┛ AppCode.

Host: GitHub
URL: https://github.com/zxj5470/bugkotlindocument
Owner: zxj5470
License: apache-2.0
Created: 2017-06-19T16:27:14.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-08-02T04:00:05.000Z (over 1 year ago)
Last Synced: 2024-10-09T18:51:41.425Z (4 months ago)
Topics: android-studio, appcode, clion, comments, documentation, intellij, intellij-plugin, jetbrains-plugin, kotlin, plugin
Language: Kotlin
Homepage:
Size: 821 KB
Stars: 31
Watchers: 4
Forks: 2
Open Issues: 8
Metadata Files:
- Readme: readme.md
- Changelog: changeNotes.html
- License: LICENSE

Awesome Lists containing this project

README

        # BugKotlinDocument

[![JetBrains plugins](https://img.shields.io/jetbrains/plugin/v/9781-bugkotlindocument.svg?style=flat-square)](https://plugins.jetbrains.com/plugin/9781-bugkotlindocument)

[![JetBrains plugins](https://img.shields.io/jetbrains/plugin/d/9781-bugkotlindocument.svg?style=flat-square)](https://plugins.jetbrains.com/plugin/9781-bugkotlindocument)

Plugin for **IntelliJ IDEA** / **Android Studio** / **CLion**, and **AppCode** is available now!

- Generate document comments for Kotlin file.

- Just generate it as Java do.

  

    CI

    Status

  

  

    AppVeyor (on Windows)

    

  

To download a nightly build, visit https://ci.appveyor.com/project/zxj5470/bugkotlindocument/build/artifacts/

# Usage 

**Just press Enter key after `/**`, just like in Java File !!!**

If it doesn't work, make sure you are not in indexing and enable smart keys for `documentation comment stub`.

![pic](https://user-images.githubusercontent.com/20026798/59451393-f7059c00-8e3d-11e9-9581-76b13f0c6dcb.png)

# Screenshots

![gif](images/pic01.gif) 

![png](images/pic02.png) 

## AppCode and CLion support!

![png](images/pic04.png) 

## Settings

**Settings/Preferences** | **Editor** | **BugKotlinDocument**

![png](images/pic03.png) 

# Install

Download the release page then install the plugin.

`Preference -> Plugin ->`

- `Install plugin from disk` in Idea/Android Studio

then enjoy Bugs!!!!

- Or `browse repositories` and search `Kotlin`/`Bug`/`Docu` is OK.

# Samples

more samples:

[main.kt](src/test/kotlin/com/github/zxj5470/bugktdoc/samples/main.kt)

[functions.kt](src/test/kotlin/com/github/zxj5470/bugktdoc/samples/functions.kt)

[constructors.kt](src/test/kotlin/com/github/zxj5470/bugktdoc/samples/constructors.kt)

# Projects use this plugin.

- [zxj5470/BugKotlinDocument](https://github.com/zxj5470/BugKotlinDocument)

**The project itself!!!**

- [ice1000/dev-kt](https://github.com/ice1000/dev-kt)

A DevCpp-like cross-platform Kotlin IDE features in lightweight.

- [ice1000/julia-intellij](https://github.com/ice1000/julia-intellij)

Julia Plugin for IntelliJ IDEA

- [zxj5470/ktlext](https://github.com/zxj5470/ktlext)

A **useless** library for Kotlin extensions. 

- [whitewoodcity/social-vertex](https://github.com/whitewoodcity/social-vertex)

A library for instant messaging framework with using [Vert.x](https://vert.io).