├── .gitignore ├── LICENSE ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── images └── gen-kdoc.gif ├── readme.md ├── settings.gradle └── src └── main ├── kotlin └── siosio │ └── kodkod │ ├── EnterAfterKDocGenHandler.kt │ └── KDocGenerator.kt └── resources └── META-INF ├── plugin.xml ├── pluginIcon.svg └── pluginIcon_dark.svg /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .gradle 3 | build 4 | out 5 | 6 | *.iml 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 siosio 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'org.jetbrains.kotlin.jvm' version '2.1.20' 3 | id 'org.jetbrains.intellij.platform' version '2.5.0' 4 | } 5 | 6 | group 'siosio' 7 | version '3.0.0' 8 | 9 | repositories { 10 | mavenCentral() 11 | intellijPlatform { 12 | defaultRepositories() 13 | } 14 | } 15 | 16 | dependencies { 17 | implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" 18 | intellijPlatform { 19 | intellijIdeaCommunity '2025.1' 20 | bundledPlugin 'com.intellij.java' 21 | bundledPlugin 'org.jetbrains.kotlin' 22 | } 23 | } 24 | 25 | kotlin { 26 | jvmToolchain(17) 27 | } 28 | 29 | tasks { 30 | patchPluginXml { 31 | sinceBuild = '250' 32 | untilBuild = '259.*' 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/siosio/kdoc-generator-intellij-plugin/a535448f6d2aedc86d6b39a975cba1274be40c9a/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sat Jan 05 07:02:40 JST 2019 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /images/gen-kdoc.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/siosio/kdoc-generator-intellij-plugin/a535448f6d2aedc86d6b39a975cba1274be40c9a/images/gen-kdoc.gif -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # kodkod 2 | This is an IntelliJ IDEA plugin. Generate kdoc. 3 | ![](images/gen-kdoc.gif) -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'kdoc-generator' 2 | 3 | -------------------------------------------------------------------------------- /src/main/kotlin/siosio/kodkod/EnterAfterKDocGenHandler.kt: -------------------------------------------------------------------------------- 1 | package siosio.kodkod 2 | 3 | import com.intellij.codeInsight.* 4 | import com.intellij.codeInsight.editorActions.enter.* 5 | import com.intellij.openapi.actionSystem.* 6 | import com.intellij.openapi.application.* 7 | import com.intellij.openapi.editor.* 8 | import com.intellij.psi.* 9 | import com.intellij.psi.codeStyle.* 10 | import com.intellij.psi.util.* 11 | import com.intellij.util.text.* 12 | import org.jetbrains.kotlin.idea.kdoc.* 13 | import org.jetbrains.kotlin.kdoc.psi.api.* 14 | import org.jetbrains.kotlin.kdoc.psi.impl.* 15 | import org.jetbrains.kotlin.psi.* 16 | import org.jetbrains.kotlin.psi.psiUtil.* 17 | 18 | class EnterAfterKDocGenHandler : EnterHandlerDelegateAdapter() { 19 | 20 | override fun postProcessEnter(file: PsiFile, 21 | editor: Editor, 22 | dataContext: DataContext): EnterHandlerDelegate.Result { 23 | 24 | if (file !is KtFile || !CodeInsightSettings.getInstance().SMART_INDENT_ON_ENTER) { 25 | return EnterHandlerDelegate.Result.Continue 26 | } 27 | 28 | val caretModel = editor.caretModel 29 | if (!isInKDoc(editor, caretModel.offset)) { 30 | return EnterHandlerDelegate.Result.Continue 31 | } 32 | 33 | val project = file.project 34 | val documentManager = PsiDocumentManager.getInstance(project) 35 | documentManager.commitAllDocuments() 36 | 37 | val elementAtCaret = file.findElementAt(caretModel.offset) 38 | val kdoc = PsiTreeUtil.getParentOfType(elementAtCaret, KDoc::class.java) 39 | ?: return EnterHandlerDelegate.Result.Continue 40 | val kdocSection = kdoc.getChildOfType() ?: return EnterHandlerDelegate.Result.Continue 41 | // KDocのセクションが空(*だけ)以外の場合は処理しない。 42 | if (kdocSection.text.trim() != "*") { 43 | return EnterHandlerDelegate.Result.Continue 44 | } 45 | 46 | ApplicationManager.getApplication().runWriteAction { 47 | val kDocElementFactory = KDocElementFactory(project) 48 | 49 | val parent = kdoc.parent 50 | when (parent) { 51 | is KtNamedFunction -> NamedFunctionKDocGenerator(parent) 52 | is KtClass -> ClassKDocGenerator(parent) 53 | else -> null 54 | }?.generate() 55 | ?.let { 56 | kDocElementFactory.createKDocFromText(it) 57 | .let { kdoc.replace(it) } 58 | .let { CodeStyleManager.getInstance(project).reformat(it) } 59 | }?.let { 60 | it.getChildOfType()?.let { 61 | caretModel.moveToOffset(it.textOffset + 6) 62 | } 63 | } 64 | } 65 | return EnterHandlerDelegate.Result.Continue 66 | } 67 | 68 | private fun isInKDoc(editor: Editor, offset: Int): Boolean { 69 | val document = editor.document 70 | val docChars = document.charsSequence 71 | var i = CharArrayUtil.lastIndexOf(docChars, "/**", offset) 72 | if (i >= 0) { 73 | i = CharArrayUtil.indexOf(docChars, "*/", i) 74 | return i > offset 75 | } 76 | return false 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /src/main/kotlin/siosio/kodkod/KDocGenerator.kt: -------------------------------------------------------------------------------- 1 | package siosio.kodkod 2 | 3 | import com.intellij.psi.* 4 | import org.jetbrains.kotlin.nj2k.postProcessing.* 5 | import org.jetbrains.kotlin.psi.* 6 | import org.jetbrains.kotlin.types.typeUtil.* 7 | 8 | interface KDocGenerator { 9 | 10 | companion object { 11 | const val LF = "\n" 12 | } 13 | 14 | fun generate(): String 15 | 16 | fun toParamsKdoc(keyword: String = "@param", params: List): String = 17 | params.map { "$keyword ${it.name}" } 18 | .joinToString(LF, transform = { "* $it" }) 19 | 20 | fun StringBuilder.appendLine(text: String): StringBuilder = append(text).append(LF) 21 | } 22 | 23 | class NamedFunctionKDocGenerator(private val function: KtNamedFunction) : KDocGenerator { 24 | override fun generate(): String { 25 | val builder = StringBuilder() 26 | builder.appendLine("/**") 27 | .appendLine("* TODO") 28 | .appendLine("*") 29 | if (function.typeParameters.isNotEmpty()) { 30 | builder.appendLine(toParamsKdoc(params = function.typeParameters)) 31 | } 32 | if (function.valueParameters.isNotEmpty()) { 33 | builder.appendLine(toParamsKdoc(params = function.valueParameters)) 34 | } 35 | 36 | val returnType = function.typeReference 37 | if (returnType != null && !returnType.text.endsWith("Unit")) { 38 | builder.appendLine("* @return") 39 | } 40 | builder.appendLine("*/") 41 | return builder.toString() 42 | } 43 | } 44 | 45 | class ClassKDocGenerator(private val klass: KtClass) : KDocGenerator { 46 | override fun generate(): String { 47 | val builder = StringBuilder() 48 | builder.appendLine("/**") 49 | .appendLine("* TODO") 50 | .appendLine("*") 51 | 52 | if (klass.typeParameters.isNotEmpty()) { 53 | builder.appendLine(toParamsKdoc(params = klass.typeParameters)) 54 | } 55 | 56 | val (properties, parameters) = klass.primaryConstructor?.valueParameters?.partition { 57 | it.hasValOrVar() 58 | } ?: Pair(emptyList(), emptyList()) 59 | 60 | if (properties.isNotEmpty()) { 61 | builder.appendLine(toParamsKdoc(keyword = "@property", params = properties)) 62 | } 63 | 64 | if (parameters.isNotEmpty()) { 65 | builder.appendLine("* @constructor") 66 | .appendLine("* TODO") 67 | .appendLine("*") 68 | .appendLine(toParamsKdoc(params = parameters)) 69 | } 70 | 71 | builder.appendLine("*/") 72 | return builder.toString() 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | siosio.kodkod 3 | Kdoc-Generator 4 | siosio 5 | 6 | 7 | 10 | 11 | 13 | 14 | com.intellij.modules.java 15 | org.jetbrains.kotlin 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/pluginIcon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | /** 24 | */ 25 | 26 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/pluginIcon_dark.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | /** 24 | */ 25 | 26 | --------------------------------------------------------------------------------