diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b63da45 --- /dev/null +++ b/.gitignore @@ -0,0 +1,42 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/encodings.xml b/.idea/encodings.xml new file mode 100644 index 0000000..8e49f84 --- /dev/null +++ b/.idea/encodings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..611e7c8 --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,17 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..81750cd --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.run/Run IDE with Plugin.run.xml b/.run/Run IDE with Plugin.run.xml new file mode 100644 index 0000000..7747a29 --- /dev/null +++ b/.run/Run IDE with Plugin.run.xml @@ -0,0 +1,24 @@ + + + + + + + + true + true + false + + + \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index a22765f..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Document generator - -根据SpringMVC 代码自动生成 API markdown文档 diff --git a/api-document-generator.iml b/api-document-generator.iml deleted file mode 100644 index c1a12e7..0000000 --- a/api-document-generator.iml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..8e209fe --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,46 @@ +plugins { + id("org.jetbrains.intellij") version "1.4.0" +} + +group = "com.docgenerator" +version = "1.0-SNAPSHOT" + +repositories { + mavenCentral() +} + +dependencies { +// https://mvnrepository.com/artifact/cn.hutool/hutool-all + implementation("cn.hutool:hutool-all:5.8.1") +} + +// Configure Gradle IntelliJ Plugin - read more: https://github.com/JetBrains/gradle-intellij-plugin +intellij { + version.set("2021.2") + type.set("IC") // Target IDE Platform + + plugins.set(listOf("com.intellij.java")) +} + +tasks { + // Set the JVM compatibility versions + withType { + sourceCompatibility = "11" + targetCompatibility = "11" + } + + patchPluginXml { + sinceBuild.set("212") + untilBuild.set("222.*") + } + + signPlugin { + certificateChain.set(System.getenv("CERTIFICATE_CHAIN")) + privateKey.set(System.getenv("PRIVATE_KEY")) + password.set(System.getenv("PRIVATE_KEY_PASSWORD")) + } + + publishPlugin { + token.set(System.getenv("PUBLISH_TOKEN")) + } +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..41dfb87 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml deleted file mode 100644 index 2d9ea64..0000000 --- a/resources/META-INF/plugin.xml +++ /dev/null @@ -1,36 +0,0 @@ - - com.your.company.unique.plugin.id - Spring Controller Api Doc Generator - 0.1 - testCompany - - 一个用来生成spring controller markdown 格式文档的插件 - - - beta - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..3dc65cc --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "api-document-generator" \ No newline at end of file diff --git a/src/plugin/doc/generate/ControllerDocumentGenerator.java b/src/main/java/com/docgenerator/mddocgenerator/ControllerDocumentGenerator.java similarity index 72% rename from src/plugin/doc/generate/ControllerDocumentGenerator.java rename to src/main/java/com/docgenerator/mddocgenerator/ControllerDocumentGenerator.java index 63fc653..914f726 100644 --- a/src/plugin/doc/generate/ControllerDocumentGenerator.java +++ b/src/main/java/com/docgenerator/mddocgenerator/ControllerDocumentGenerator.java @@ -1,46 +1,36 @@ -package plugin.doc.generate; - +package com.docgenerator.mddocgenerator; + +import com.docgenerator.mddocgenerator.contact.SpringContact; +import com.docgenerator.mddocgenerator.definition.RestFulDefinition; +import com.docgenerator.mddocgenerator.delegate.DelegateFactory; +import com.docgenerator.mddocgenerator.generator.RestDocumentGenerator; +import com.docgenerator.mddocgenerator.parser.RestParser; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; +import com.docgenerator.mddocgenerator.utils.StringUtils; +import com.docgenerator.mddocgenerator.view.DocumentExportDialog; import com.intellij.openapi.actionSystem.AnAction; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.psi.PsiClass; import com.intellij.psi.PsiJavaFile; import com.intellij.psi.PsiMethod; -import plugin.doc.generate.contact.SpringContact; -import plugin.doc.generate.definition.RestFulDefinition; -import plugin.doc.generate.delegate.DelegateFactory; -import plugin.doc.generate.delegate.GeneratorDelegate; -import plugin.doc.generate.generator.RestDocumentGenerator; -import plugin.doc.generate.parser.RestParser; -import plugin.doc.generate.utils.MyPsiSupport; -import plugin.doc.generate.utils.StringUtils; -import plugin.doc.generate.view.DocumentExportDialog; +import org.jetbrains.annotations.NotNull; import java.awt.*; -import java.util.*; import java.util.List; +import java.util.*; import java.util.stream.Collectors; public class ControllerDocumentGenerator extends AnAction { - private GeneratorDelegate delegate; - private Set psiMethods; - private GeneratorDelegate getDelegate() { - if (delegate == null) { - delegate = DelegateFactory.getGeneratorDelegate(this.getClass()); - } - return delegate; - } - - @Override - public void actionPerformed(AnActionEvent anActionEvent) { - List definitions = parseSelectedMethod(anActionEvent); + public void actionPerformed(@NotNull AnActionEvent e) { + List definitions = parseSelectedMethod(e); if (definitions != null && definitions.size() != 0) { StringBuffer builder = new StringBuffer(); - definitions.forEach(e -> { - RestDocumentGenerator generator = new RestDocumentGenerator(e); + definitions.forEach(d -> { + RestDocumentGenerator generator = new RestDocumentGenerator(d); String content = generator.generate(); builder.append(content); builder.append("\n"); @@ -49,25 +39,12 @@ public void actionPerformed(AnActionEvent anActionEvent) { } } - /** - * 打开结果对话框 - * - * @param result - */ - protected void openDialog(String result) { - Dimension screensize = Toolkit.getDefaultToolkit().getScreenSize(); - double width = screensize.width; - double height = screensize.height; - - DocumentExportDialog dialog = new DocumentExportDialog(result); - dialog.pack(); - dialog.setSize((int) (width * 0.25), (int) (height * 0.5)); - dialog.setLocation((int) (width * 0.33), (int) (height * 0.2)); - dialog.setVisible(true); - + @Override + public void update(@NotNull AnActionEvent e) { + super.update(e); + DelegateFactory.getGeneratorDelegate(this.getClass()).doUpdate(e); } - private List parseSelectedMethod(AnActionEvent anActionEvent) { PsiJavaFile javaFile = MyPsiSupport.getPsiJavaFile(anActionEvent); //获得相应带有@RestController 的类 @@ -80,7 +57,7 @@ private List parseSelectedMethod(AnActionEvent anActionEvent) return Collections.singletonList(parser.getDefinition()); } else { ArrayList list = new ArrayList<>(); - // 生成类文档 + //生成类文档 return this.psiMethods.stream().map(e -> { RestParser parser = new RestParser(e); parser.parseDefinition(); @@ -102,7 +79,6 @@ private PsiMethod getPsiMethodSelecting(AnActionEvent anActionEvent) { return null; } - private Set getMethod(List classes) { List postMethods = MyPsiSupport.getPsiMethods(classes, SpringContact.ANNOTATION_POSTMAPPING); List requestMethods = MyPsiSupport.getPsiMethods(classes, SpringContact.ANNOTATION_REQUESTMAPPING); @@ -119,17 +95,14 @@ private Set getMethod(List classes) { } - @Override - public boolean isDumbAware() { - return false; - } - - - @Override - public void update(AnActionEvent e) { - super.update(e); - this.getDelegate().doUpdate(e); + private void openDialog(String result) { + Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize(); + double width = screenSize.width; + double height = screenSize.height; + DocumentExportDialog dialog = new DocumentExportDialog(result); + dialog.pack(); + dialog.setSize((int) (width * 0.25), (int) (height * 0.5)); + dialog.setLocation((int) (width * 0.33), (int) (height * 0.2)); + dialog.setVisible(true); } - - } diff --git a/src/plugin/doc/generate/checker/EventChecker.java b/src/main/java/com/docgenerator/mddocgenerator/checker/EventChecker.java similarity index 73% rename from src/plugin/doc/generate/checker/EventChecker.java rename to src/main/java/com/docgenerator/mddocgenerator/checker/EventChecker.java index 2384a2c..c729d9d 100644 --- a/src/plugin/doc/generate/checker/EventChecker.java +++ b/src/main/java/com/docgenerator/mddocgenerator/checker/EventChecker.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.checker; +package com.docgenerator.mddocgenerator.checker; import com.intellij.openapi.actionSystem.AnActionEvent; diff --git a/src/plugin/doc/generate/checker/impl/EditorAvailableChecker.java b/src/main/java/com/docgenerator/mddocgenerator/checker/impl/EditorAvailableChecker.java similarity index 73% rename from src/plugin/doc/generate/checker/impl/EditorAvailableChecker.java rename to src/main/java/com/docgenerator/mddocgenerator/checker/impl/EditorAvailableChecker.java index 3110fcc..e772612 100644 --- a/src/plugin/doc/generate/checker/impl/EditorAvailableChecker.java +++ b/src/main/java/com/docgenerator/mddocgenerator/checker/impl/EditorAvailableChecker.java @@ -1,17 +1,15 @@ -package plugin.doc.generate.checker.impl; +package com.docgenerator.mddocgenerator.checker.impl; +import com.docgenerator.mddocgenerator.checker.EventChecker; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.openapi.actionSystem.PlatformDataKeys; import com.intellij.openapi.editor.Editor; -import plugin.doc.generate.checker.EventChecker; public class EditorAvailableChecker implements EventChecker { @Override public boolean check(AnActionEvent event) { Editor editor = event.getData(PlatformDataKeys.EDITOR); - - //如果没有打开编辑框就不显示 return editor != null; } } diff --git a/src/plugin/doc/generate/checker/impl/JavaFileChecker.java b/src/main/java/com/docgenerator/mddocgenerator/checker/impl/JavaFileChecker.java similarity index 67% rename from src/plugin/doc/generate/checker/impl/JavaFileChecker.java rename to src/main/java/com/docgenerator/mddocgenerator/checker/impl/JavaFileChecker.java index ef0f8ba..0c6eb7f 100644 --- a/src/plugin/doc/generate/checker/impl/JavaFileChecker.java +++ b/src/main/java/com/docgenerator/mddocgenerator/checker/impl/JavaFileChecker.java @@ -1,9 +1,9 @@ -package plugin.doc.generate.checker.impl; +package com.docgenerator.mddocgenerator.checker.impl; +import com.docgenerator.mddocgenerator.checker.EventChecker; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.psi.PsiJavaFile; -import plugin.doc.generate.checker.EventChecker; -import plugin.doc.generate.utils.MyPsiSupport; public class JavaFileChecker implements EventChecker { @Override diff --git a/src/plugin/doc/generate/checker/impl/SpringControllerChecker.java b/src/main/java/com/docgenerator/mddocgenerator/checker/impl/SpringControllerChecker.java similarity index 82% rename from src/plugin/doc/generate/checker/impl/SpringControllerChecker.java rename to src/main/java/com/docgenerator/mddocgenerator/checker/impl/SpringControllerChecker.java index 4bc8ebb..9c67c78 100644 --- a/src/plugin/doc/generate/checker/impl/SpringControllerChecker.java +++ b/src/main/java/com/docgenerator/mddocgenerator/checker/impl/SpringControllerChecker.java @@ -1,10 +1,10 @@ -package plugin.doc.generate.checker.impl; +package com.docgenerator.mddocgenerator.checker.impl; +import com.docgenerator.mddocgenerator.checker.EventChecker; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.psi.PsiAnnotation; import com.intellij.psi.PsiClass; -import plugin.doc.generate.checker.EventChecker; -import plugin.doc.generate.utils.MyPsiSupport; public class SpringControllerChecker implements EventChecker { diff --git a/src/plugin/doc/generate/contact/ParamRequiredAnnotationQualifiedNames.java b/src/main/java/com/docgenerator/mddocgenerator/contact/ParamRequiredAnnotationQualifiedNames.java similarity index 94% rename from src/plugin/doc/generate/contact/ParamRequiredAnnotationQualifiedNames.java rename to src/main/java/com/docgenerator/mddocgenerator/contact/ParamRequiredAnnotationQualifiedNames.java index 4611393..988b294 100644 --- a/src/plugin/doc/generate/contact/ParamRequiredAnnotationQualifiedNames.java +++ b/src/main/java/com/docgenerator/mddocgenerator/contact/ParamRequiredAnnotationQualifiedNames.java @@ -1,7 +1,7 @@ -package plugin.doc.generate.contact; +package com.docgenerator.mddocgenerator.contact; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.psi.PsiAnnotation; -import plugin.doc.generate.utils.MyPsiSupport; import java.util.HashSet; diff --git a/src/plugin/doc/generate/contact/SpringContact.java b/src/main/java/com/docgenerator/mddocgenerator/contact/SpringContact.java similarity index 94% rename from src/plugin/doc/generate/contact/SpringContact.java rename to src/main/java/com/docgenerator/mddocgenerator/contact/SpringContact.java index a012434..61cfe44 100644 --- a/src/plugin/doc/generate/contact/SpringContact.java +++ b/src/main/java/com/docgenerator/mddocgenerator/contact/SpringContact.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.contact; +package com.docgenerator.mddocgenerator.contact; public class SpringContact { diff --git a/src/plugin/doc/generate/definition/BodyType.java b/src/main/java/com/docgenerator/mddocgenerator/definition/BodyType.java similarity index 55% rename from src/plugin/doc/generate/definition/BodyType.java rename to src/main/java/com/docgenerator/mddocgenerator/definition/BodyType.java index a0c158f..8d39ca3 100644 --- a/src/plugin/doc/generate/definition/BodyType.java +++ b/src/main/java/com/docgenerator/mddocgenerator/definition/BodyType.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.definition; +package com.docgenerator.mddocgenerator.definition; public enum BodyType { RequestBody, FormData, JSON, Params diff --git a/src/plugin/doc/generate/definition/FieldDefinition.java b/src/main/java/com/docgenerator/mddocgenerator/definition/FieldDefinition.java similarity index 95% rename from src/plugin/doc/generate/definition/FieldDefinition.java rename to src/main/java/com/docgenerator/mddocgenerator/definition/FieldDefinition.java index 2c891e2..fa76b13 100644 --- a/src/plugin/doc/generate/definition/FieldDefinition.java +++ b/src/main/java/com/docgenerator/mddocgenerator/definition/FieldDefinition.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.definition; +package com.docgenerator.mddocgenerator.definition; import java.util.List; diff --git a/src/plugin/doc/generate/definition/RestFulDefinition.java b/src/main/java/com/docgenerator/mddocgenerator/definition/RestFulDefinition.java similarity index 97% rename from src/plugin/doc/generate/definition/RestFulDefinition.java rename to src/main/java/com/docgenerator/mddocgenerator/definition/RestFulDefinition.java index ec291de..50ad69f 100644 --- a/src/plugin/doc/generate/definition/RestFulDefinition.java +++ b/src/main/java/com/docgenerator/mddocgenerator/definition/RestFulDefinition.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.definition; +package com.docgenerator.mddocgenerator.definition; import java.util.List; diff --git a/src/plugin/doc/generate/delegate/DelegateFactory.java b/src/main/java/com/docgenerator/mddocgenerator/delegate/DelegateFactory.java similarity index 50% rename from src/plugin/doc/generate/delegate/DelegateFactory.java rename to src/main/java/com/docgenerator/mddocgenerator/delegate/DelegateFactory.java index a16f685..3474399 100644 --- a/src/plugin/doc/generate/delegate/DelegateFactory.java +++ b/src/main/java/com/docgenerator/mddocgenerator/delegate/DelegateFactory.java @@ -1,8 +1,8 @@ -package plugin.doc.generate.delegate; +package com.docgenerator.mddocgenerator.delegate; -import plugin.doc.generate.ControllerDocumentGenerator; -import plugin.doc.generate.delegate.impl.ControllerDocumentDelegate; -import plugin.doc.generate.delegate.impl.DefaultDelegateFactory; +import com.docgenerator.mddocgenerator.ControllerDocumentGenerator; +import com.docgenerator.mddocgenerator.delegate.impl.ControllerDocumentDelegate; +import com.docgenerator.mddocgenerator.delegate.impl.DefaultDelegateFactory; public class DelegateFactory { diff --git a/src/plugin/doc/generate/delegate/GeneratorDelegate.java b/src/main/java/com/docgenerator/mddocgenerator/delegate/GeneratorDelegate.java similarity index 86% rename from src/plugin/doc/generate/delegate/GeneratorDelegate.java rename to src/main/java/com/docgenerator/mddocgenerator/delegate/GeneratorDelegate.java index 7e2b679..ba4a9d8 100644 --- a/src/plugin/doc/generate/delegate/GeneratorDelegate.java +++ b/src/main/java/com/docgenerator/mddocgenerator/delegate/GeneratorDelegate.java @@ -1,7 +1,7 @@ -package plugin.doc.generate.delegate; +package com.docgenerator.mddocgenerator.delegate; +import com.docgenerator.mddocgenerator.checker.EventChecker; import com.intellij.openapi.actionSystem.AnActionEvent; -import plugin.doc.generate.checker.EventChecker; import java.util.HashSet; import java.util.Set; diff --git a/src/main/java/com/docgenerator/mddocgenerator/delegate/impl/ControllerDocumentDelegate.java b/src/main/java/com/docgenerator/mddocgenerator/delegate/impl/ControllerDocumentDelegate.java new file mode 100644 index 0000000..fa12862 --- /dev/null +++ b/src/main/java/com/docgenerator/mddocgenerator/delegate/impl/ControllerDocumentDelegate.java @@ -0,0 +1,16 @@ +package com.docgenerator.mddocgenerator.delegate.impl; + +import com.docgenerator.mddocgenerator.checker.impl.EditorAvailableChecker; +import com.docgenerator.mddocgenerator.checker.impl.JavaFileChecker; +import com.docgenerator.mddocgenerator.checker.impl.SpringControllerChecker; +import com.docgenerator.mddocgenerator.delegate.GeneratorDelegate; + +public class ControllerDocumentDelegate extends GeneratorDelegate { + + public ControllerDocumentDelegate() { + this.addChecker(new EditorAvailableChecker()); + this.addChecker(new JavaFileChecker()); + this.addChecker(new SpringControllerChecker()); + } + +} diff --git a/src/main/java/com/docgenerator/mddocgenerator/delegate/impl/DefaultDelegateFactory.java b/src/main/java/com/docgenerator/mddocgenerator/delegate/impl/DefaultDelegateFactory.java new file mode 100644 index 0000000..88a14a2 --- /dev/null +++ b/src/main/java/com/docgenerator/mddocgenerator/delegate/impl/DefaultDelegateFactory.java @@ -0,0 +1,6 @@ +package com.docgenerator.mddocgenerator.delegate.impl; + +import com.docgenerator.mddocgenerator.delegate.GeneratorDelegate; + +public class DefaultDelegateFactory extends GeneratorDelegate { +} diff --git a/src/plugin/doc/generate/generator/MarkDownGenerator.java b/src/main/java/com/docgenerator/mddocgenerator/generator/MarkDownGenerator.java similarity index 97% rename from src/plugin/doc/generate/generator/MarkDownGenerator.java rename to src/main/java/com/docgenerator/mddocgenerator/generator/MarkDownGenerator.java index 1c7e02e..b01019b 100644 --- a/src/plugin/doc/generate/generator/MarkDownGenerator.java +++ b/src/main/java/com/docgenerator/mddocgenerator/generator/MarkDownGenerator.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.generator; +package com.docgenerator.mddocgenerator.generator; import java.lang.reflect.Field; import java.util.List; diff --git a/src/plugin/doc/generate/generator/RestDocumentGenerator.java b/src/main/java/com/docgenerator/mddocgenerator/generator/RestDocumentGenerator.java similarity index 85% rename from src/plugin/doc/generate/generator/RestDocumentGenerator.java rename to src/main/java/com/docgenerator/mddocgenerator/generator/RestDocumentGenerator.java index 95fb13a..683872a 100644 --- a/src/plugin/doc/generate/generator/RestDocumentGenerator.java +++ b/src/main/java/com/docgenerator/mddocgenerator/generator/RestDocumentGenerator.java @@ -1,7 +1,7 @@ -package plugin.doc.generate.generator; +package com.docgenerator.mddocgenerator.generator; -import plugin.doc.generate.definition.FieldDefinition; -import plugin.doc.generate.definition.RestFulDefinition; +import com.docgenerator.mddocgenerator.definition.FieldDefinition; +import com.docgenerator.mddocgenerator.definition.RestFulDefinition; import java.util.List; @@ -49,29 +49,29 @@ public String interfaceNamePart() { } public String urlPart() { - return "> 请求URL：`" + this.definition.getUri() + "`\n"; + return "> URL`" + this.definition.getUri() + "`\n"; } public String methodPart() { - return "> 请求方式：`" + this.definition.getHttpMethod().toUpperCase() + "`,`" + this.definition.getRequestBodyType().toString() + "`\n"; + return "> ʽ`" + this.definition.getHttpMethod().toUpperCase() + "`,`" + this.definition.getRequestBodyType().toString() + "`\n"; } public String requestPart() { - StringBuffer stringBuffer = new StringBuffer("### 请求参数\n \n"); + StringBuffer stringBuffer = new StringBuffer("### \n \n"); List fieldDefinitions = this.definition.getRequest(); if (fieldDefinitions == null || fieldDefinitions.isEmpty()) { - stringBuffer.append("无参数\n"); + stringBuffer.append("޲\n"); return stringBuffer.toString(); } - stringBuffer.append("|参数名|类型|说明|必选|\n"); + stringBuffer.append("|||˵|ѡ|\n"); stringBuffer.append("|:---- |:---|:----- |----- |\n"); stringBuffer.append(this.requestDefinitionTableBody(fieldDefinitions)); return stringBuffer.toString(); } public String responsePart() { - StringBuffer stringBuffer = new StringBuffer("### 返回参数\n \n"); - stringBuffer.append("|参数名|类型|说明|\n"); + StringBuffer stringBuffer = new StringBuffer("### ز\n \n"); + stringBuffer.append("|||˵|\n"); stringBuffer.append("|:---- |:----- |----- |\n"); List fieldDefinitions = this.definition.getResponse(); stringBuffer.append(this.responseDefinitionTableBody(fieldDefinitions)); @@ -106,7 +106,7 @@ public String requestDefinitionTableBody(List fieldDefinitions) stringBuffer.append("|" + layerChat + definition.getName()); stringBuffer.append("|" + definition.getType()); stringBuffer.append("|" + definition.getDesc()); - stringBuffer.append("|" + (definition.isRequire() ? "是" : "")); + stringBuffer.append("|" + (definition.isRequire() ? "" : "")); stringBuffer.append("|\n"); if (definition.getSubFieldDefinitions() != null && !definition.getSubFieldDefinitions().isEmpty()) { stringBuffer.append(this.responseDefinitionTableBody(definition.getSubFieldDefinitions())); diff --git a/src/plugin/doc/generate/parser/JsonParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/JsonParser.java similarity index 96% rename from src/plugin/doc/generate/parser/JsonParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/JsonParser.java index 7693673..50bca94 100644 --- a/src/plugin/doc/generate/parser/JsonParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/JsonParser.java @@ -1,12 +1,14 @@ -package plugin.doc.generate.parser; +package com.docgenerator.mddocgenerator.parser; import cn.hutool.json.JSONObject; import cn.hutool.json.JSONUtil; -import com.intellij.psi.*; -import plugin.doc.generate.parser.translator.TypeInstanceTranslator; -import plugin.doc.generate.parser.translator.TypeTranslator; -import plugin.doc.generate.utils.Convertor; -import plugin.doc.generate.utils.MyPsiSupport; +import com.docgenerator.mddocgenerator.parser.translator.TypeInstanceTranslator; +import com.docgenerator.mddocgenerator.parser.translator.TypeTranslator; +import com.docgenerator.mddocgenerator.utils.Convertor; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; +import com.intellij.psi.PsiClass; +import com.intellij.psi.PsiField; +import com.intellij.psi.PsiType; import java.util.ArrayList; import java.util.List; diff --git a/src/plugin/doc/generate/parser/MapParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/MapParser.java similarity index 92% rename from src/plugin/doc/generate/parser/MapParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/MapParser.java index d0f536c..e2cb9a6 100644 --- a/src/plugin/doc/generate/parser/MapParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/MapParser.java @@ -1,12 +1,12 @@ -package plugin.doc.generate.parser; +package com.docgenerator.mddocgenerator.parser; +import com.docgenerator.mddocgenerator.parser.translator.TypeInstanceTranslator; +import com.docgenerator.mddocgenerator.parser.translator.TypeTranslator; +import com.docgenerator.mddocgenerator.utils.Convertor; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.psi.PsiClass; import com.intellij.psi.PsiField; import com.intellij.psi.PsiType; -import plugin.doc.generate.parser.translator.TypeInstanceTranslator; -import plugin.doc.generate.parser.translator.TypeTranslator; -import plugin.doc.generate.utils.Convertor; -import plugin.doc.generate.utils.MyPsiSupport; import java.util.ArrayList; import java.util.HashMap; diff --git a/src/plugin/doc/generate/parser/ObjectParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/ObjectParser.java similarity index 90% rename from src/plugin/doc/generate/parser/ObjectParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/ObjectParser.java index cab7daf..f4cb082 100644 --- a/src/plugin/doc/generate/parser/ObjectParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/ObjectParser.java @@ -1,14 +1,16 @@ -package plugin.doc.generate.parser; - +package com.docgenerator.mddocgenerator.parser; + +import com.docgenerator.mddocgenerator.contact.ParamRequiredAnnotationQualifiedNames; +import com.docgenerator.mddocgenerator.definition.FieldDefinition; +import com.docgenerator.mddocgenerator.parser.translator.TypeTranslator; +import com.docgenerator.mddocgenerator.utils.Convertor; +import com.docgenerator.mddocgenerator.utils.JavaDocUtils; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.openapi.project.Project; -import com.intellij.psi.*; +import com.intellij.psi.PsiClass; +import com.intellij.psi.PsiField; +import com.intellij.psi.PsiType; import com.intellij.psi.util.PsiUtil; -import plugin.doc.generate.contact.ParamRequiredAnnotationQualifiedNames; -import plugin.doc.generate.definition.FieldDefinition; -import plugin.doc.generate.parser.translator.TypeTranslator; -import plugin.doc.generate.utils.Convertor; -import plugin.doc.generate.utils.JavaDocUtils; -import plugin.doc.generate.utils.MyPsiSupport; import java.util.ArrayList; import java.util.List; diff --git a/src/plugin/doc/generate/parser/ParameterParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/ParameterParser.java similarity index 87% rename from src/plugin/doc/generate/parser/ParameterParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/ParameterParser.java index 51c2308..5a496ec 100644 --- a/src/plugin/doc/generate/parser/ParameterParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/ParameterParser.java @@ -1,11 +1,11 @@ -package plugin.doc.generate.parser; +package com.docgenerator.mddocgenerator.parser; +import com.docgenerator.mddocgenerator.contact.ParamRequiredAnnotationQualifiedNames; +import com.docgenerator.mddocgenerator.definition.FieldDefinition; +import com.docgenerator.mddocgenerator.parser.translator.TypeTranslator; +import com.docgenerator.mddocgenerator.utils.JavaDocUtils; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.psi.*; -import plugin.doc.generate.contact.ParamRequiredAnnotationQualifiedNames; -import plugin.doc.generate.definition.FieldDefinition; -import plugin.doc.generate.parser.translator.TypeTranslator; -import plugin.doc.generate.utils.JavaDocUtils; -import plugin.doc.generate.utils.MyPsiSupport; import java.util.ArrayList; import java.util.List; @@ -71,7 +71,7 @@ public FieldDefinition parseSingleParameterDefinition(PsiParameter psiParameter) paramName = psiParameter.getName(); } - String desc = JavaDocUtils.getParamsDesc(psiMethod.getDocComment(), paramName); + String desc = JavaDocUtils.getParamsDesc(psiMethod.getDocComment(), psiParameter.getName()); definition.setName(paramName); definition.setLayer(0); diff --git a/src/plugin/doc/generate/parser/ParamsJsonParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/ParamsJsonParser.java similarity index 88% rename from src/plugin/doc/generate/parser/ParamsJsonParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/ParamsJsonParser.java index 565202e..f25870d 100644 --- a/src/plugin/doc/generate/parser/ParamsJsonParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/ParamsJsonParser.java @@ -1,10 +1,10 @@ -package plugin.doc.generate.parser; +package com.docgenerator.mddocgenerator.parser; import cn.hutool.json.JSONObject; import cn.hutool.json.JSONUtil; +import com.docgenerator.mddocgenerator.parser.translator.TypeInstanceTranslator; import com.intellij.psi.PsiParameter; import com.intellij.psi.PsiType; -import plugin.doc.generate.parser.translator.TypeInstanceTranslator; public class ParamsJsonParser extends Parser { private PsiParameter[] psiParameter; diff --git a/src/plugin/doc/generate/parser/Parser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/Parser.java similarity index 79% rename from src/plugin/doc/generate/parser/Parser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/Parser.java index a330dc7..c49342b 100644 --- a/src/plugin/doc/generate/parser/Parser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/Parser.java @@ -1,8 +1,8 @@ -package plugin.doc.generate.parser; +package com.docgenerator.mddocgenerator.parser; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; import com.intellij.psi.PsiField; import com.intellij.psi.PsiType; -import plugin.doc.generate.utils.MyPsiSupport; public abstract class Parser { diff --git a/src/plugin/doc/generate/parser/RestParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/RestParser.java similarity index 96% rename from src/plugin/doc/generate/parser/RestParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/RestParser.java index 8642bba..0cbbc03 100644 --- a/src/plugin/doc/generate/parser/RestParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/RestParser.java @@ -1,17 +1,17 @@ -package plugin.doc.generate.parser; - +package com.docgenerator.mddocgenerator.parser; + +import com.docgenerator.mddocgenerator.contact.SpringContact; +import com.docgenerator.mddocgenerator.definition.BodyType; +import com.docgenerator.mddocgenerator.definition.FieldDefinition; +import com.docgenerator.mddocgenerator.definition.RestFulDefinition; +import com.docgenerator.mddocgenerator.utils.JavaDocUtils; +import com.docgenerator.mddocgenerator.utils.MyPsiSupport; +import com.docgenerator.mddocgenerator.utils.StringUtils; import com.intellij.openapi.module.Module; import com.intellij.openapi.module.ModuleUtil; import com.intellij.psi.*; import com.intellij.psi.search.FilenameIndex; import com.intellij.psi.search.GlobalSearchScope; -import plugin.doc.generate.contact.SpringContact; -import plugin.doc.generate.definition.BodyType; -import plugin.doc.generate.definition.FieldDefinition; -import plugin.doc.generate.definition.RestFulDefinition; -import plugin.doc.generate.utils.JavaDocUtils; -import plugin.doc.generate.utils.MyPsiSupport; -import plugin.doc.generate.utils.StringUtils; import java.util.List; diff --git a/src/plugin/doc/generate/parser/YamlParser.java b/src/main/java/com/docgenerator/mddocgenerator/parser/YamlParser.java similarity index 91% rename from src/plugin/doc/generate/parser/YamlParser.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/YamlParser.java index b83110f..44c1af0 100644 --- a/src/plugin/doc/generate/parser/YamlParser.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/YamlParser.java @@ -1,12 +1,15 @@ -package plugin.doc.generate.parser; +package com.docgenerator.mddocgenerator.parser; +import com.docgenerator.mddocgenerator.utils.StringUtils; import com.intellij.psi.PsiFile; -import plugin.doc.generate.utils.StringUtils; import org.yaml.snakeyaml.Yaml; import java.io.IOException; import java.io.InputStream; -import java.util.*; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; public class YamlParser extends Parser { diff --git a/src/plugin/doc/generate/parser/translator/TypeInstanceTranslator.java b/src/main/java/com/docgenerator/mddocgenerator/parser/translator/TypeInstanceTranslator.java similarity index 91% rename from src/plugin/doc/generate/parser/translator/TypeInstanceTranslator.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/translator/TypeInstanceTranslator.java index 0a94809..39f9691 100644 --- a/src/plugin/doc/generate/parser/translator/TypeInstanceTranslator.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/translator/TypeInstanceTranslator.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.parser.translator; +package com.docgenerator.mddocgenerator.parser.translator; public class TypeInstanceTranslator { public static Object translate(String canonicalText) { diff --git a/src/plugin/doc/generate/parser/translator/TypeTranslator.java b/src/main/java/com/docgenerator/mddocgenerator/parser/translator/TypeTranslator.java similarity index 98% rename from src/plugin/doc/generate/parser/translator/TypeTranslator.java rename to src/main/java/com/docgenerator/mddocgenerator/parser/translator/TypeTranslator.java index 6f0d964..4e272bc 100644 --- a/src/plugin/doc/generate/parser/translator/TypeTranslator.java +++ b/src/main/java/com/docgenerator/mddocgenerator/parser/translator/TypeTranslator.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.parser.translator; +package com.docgenerator.mddocgenerator.parser.translator; import java.util.HashSet; import java.util.Set; diff --git a/src/plugin/doc/generate/utils/ClassUtils.java b/src/main/java/com/docgenerator/mddocgenerator/utils/ClassUtils.java similarity index 79% rename from src/plugin/doc/generate/utils/ClassUtils.java rename to src/main/java/com/docgenerator/mddocgenerator/utils/ClassUtils.java index 7389b43..0013066 100644 --- a/src/plugin/doc/generate/utils/ClassUtils.java +++ b/src/main/java/com/docgenerator/mddocgenerator/utils/ClassUtils.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.utils; +package com.docgenerator.mddocgenerator.utils; import java.util.HashMap; import java.util.Map; diff --git a/src/plugin/doc/generate/utils/Convertor.java b/src/main/java/com/docgenerator/mddocgenerator/utils/Convertor.java similarity index 97% rename from src/plugin/doc/generate/utils/Convertor.java rename to src/main/java/com/docgenerator/mddocgenerator/utils/Convertor.java index 108c454..f29ac96 100644 --- a/src/plugin/doc/generate/utils/Convertor.java +++ b/src/main/java/com/docgenerator/mddocgenerator/utils/Convertor.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.utils; +package com.docgenerator.mddocgenerator.utils; import java.util.HashSet; import java.util.Set; diff --git a/src/plugin/doc/generate/utils/JavaDocUtils.java b/src/main/java/com/docgenerator/mddocgenerator/utils/JavaDocUtils.java similarity index 97% rename from src/plugin/doc/generate/utils/JavaDocUtils.java rename to src/main/java/com/docgenerator/mddocgenerator/utils/JavaDocUtils.java index baa4689..41eb20f 100644 --- a/src/plugin/doc/generate/utils/JavaDocUtils.java +++ b/src/main/java/com/docgenerator/mddocgenerator/utils/JavaDocUtils.java @@ -1,7 +1,6 @@ -package plugin.doc.generate.utils; +package com.docgenerator.mddocgenerator.utils; import com.intellij.psi.PsiElement; -import com.intellij.psi.PsiMethod; import com.intellij.psi.javadoc.PsiDocComment; import com.intellij.psi.javadoc.PsiDocTag; import com.intellij.psi.javadoc.PsiDocToken; diff --git a/src/plugin/doc/generate/utils/MyPsiSupport.java b/src/main/java/com/docgenerator/mddocgenerator/utils/MyPsiSupport.java similarity index 99% rename from src/plugin/doc/generate/utils/MyPsiSupport.java rename to src/main/java/com/docgenerator/mddocgenerator/utils/MyPsiSupport.java index 2b335f5..8ebe54e 100644 --- a/src/plugin/doc/generate/utils/MyPsiSupport.java +++ b/src/main/java/com/docgenerator/mddocgenerator/utils/MyPsiSupport.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.utils; +package com.docgenerator.mddocgenerator.utils; import com.intellij.lang.jvm.annotation.JvmAnnotationAttribute; import com.intellij.openapi.actionSystem.AnActionEvent; @@ -10,7 +10,6 @@ import com.intellij.psi.impl.source.tree.java.PsiNameValuePairImpl; import com.intellij.psi.search.GlobalSearchScope; import com.intellij.psi.util.PsiUtil; -import org.jetbrains.annotations.NotNull; import java.util.ArrayList; import java.util.List; diff --git a/src/plugin/doc/generate/utils/StringUtils.java b/src/main/java/com/docgenerator/mddocgenerator/utils/StringUtils.java similarity index 74% rename from src/plugin/doc/generate/utils/StringUtils.java rename to src/main/java/com/docgenerator/mddocgenerator/utils/StringUtils.java index 39c07fb..a0785c0 100644 --- a/src/plugin/doc/generate/utils/StringUtils.java +++ b/src/main/java/com/docgenerator/mddocgenerator/utils/StringUtils.java @@ -1,4 +1,4 @@ -package plugin.doc.generate.utils; +package com.docgenerator.mddocgenerator.utils; public class StringUtils { diff --git a/src/plugin/doc/generate/view/DocumentExportDialog.form b/src/main/java/com/docgenerator/mddocgenerator/view/DocumentExportDialog.form similarity index 98% rename from src/plugin/doc/generate/view/DocumentExportDialog.form rename to src/main/java/com/docgenerator/mddocgenerator/view/DocumentExportDialog.form index 9aa0e49..2643cdf 100644 --- a/src/plugin/doc/generate/view/DocumentExportDialog.form +++ b/src/main/java/com/docgenerator/mddocgenerator/view/DocumentExportDialog.form @@ -1,5 +1,5 @@ -
+ diff --git a/src/plugin/doc/generate/view/DocumentExportDialog.java b/src/main/java/com/docgenerator/mddocgenerator/view/DocumentExportDialog.java similarity index 58% rename from src/plugin/doc/generate/view/DocumentExportDialog.java rename to src/main/java/com/docgenerator/mddocgenerator/view/DocumentExportDialog.java index 0c9637a..7f3d148 100644 --- a/src/plugin/doc/generate/view/DocumentExportDialog.java +++ b/src/main/java/com/docgenerator/mddocgenerator/view/DocumentExportDialog.java @@ -1,10 +1,12 @@ -package plugin.doc.generate.view; +package com.docgenerator.mddocgenerator.view; import javax.swing.*; import java.awt.*; import java.awt.datatransfer.Clipboard; import java.awt.datatransfer.StringSelection; -import java.awt.event.*; +import java.awt.event.KeyEvent; +import java.awt.event.WindowAdapter; +import java.awt.event.WindowEvent; public class DocumentExportDialog extends JDialog { private JPanel contentPane; @@ -18,17 +20,9 @@ public DocumentExportDialog(String documentContent) { getRootPane().setDefaultButton(buttonCopy); documentTextArea.setText(documentContent); - buttonCopy.addActionListener(new ActionListener() { - public void actionPerformed(ActionEvent e) { - onOK(); - } - }); + buttonCopy.addActionListener(e -> onOK()); - buttonCancel.addActionListener(new ActionListener() { - public void actionPerformed(ActionEvent e) { - onCancel(); - } - }); + buttonCancel.addActionListener(e -> onCancel()); // call onCancel() when cross is clicked setDefaultCloseOperation(DO_NOTHING_ON_CLOSE); @@ -39,11 +33,7 @@ public void windowClosing(WindowEvent e) { }); // call onCancel() on ESCAPE - contentPane.registerKeyboardAction(new ActionListener() { - public void actionPerformed(ActionEvent e) { - onCancel(); - } - }, KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT); + contentPane.registerKeyboardAction(e -> onCancel(), KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT); } private void onOK() { @@ -58,11 +48,4 @@ private void onCancel() { // add your code here if necessary dispose(); } - - public static void main(String[] args) { - DocumentExportDialog dialog = new DocumentExportDialog(""); - dialog.pack(); - dialog.setVisible(true); - System.exit(0); - } } diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml new file mode 100644 index 0000000..8686ac4 --- /dev/null +++ b/src/main/resources/META-INF/plugin.xml @@ -0,0 +1,38 @@ + + + + com.docgenerator.mddocgenerator + + + MD Doc Generator + + + YourCompany + + + + most HTML tags may be used + ]]> + + + com.intellij.modules.platform + com.intellij.modules.java + + + + + + + + + + + \ No newline at end of file diff --git a/src/main/resources/META-INF/pluginIcon.svg b/src/main/resources/META-INF/pluginIcon.svg new file mode 100644 index 0000000..dcf6b99 --- /dev/null +++ b/src/main/resources/META-INF/pluginIcon.svg @@ -0,0 +1,12 @@ + + + + + + + + + + \ No newline at end of file diff --git a/src/plugin/doc/generate/delegate/impl/ControllerDocumentDelegate.java b/src/plugin/doc/generate/delegate/impl/ControllerDocumentDelegate.java deleted file mode 100644 index 92d1a2f..0000000 --- a/src/plugin/doc/generate/delegate/impl/ControllerDocumentDelegate.java +++ /dev/null @@ -1,16 +0,0 @@ -package plugin.doc.generate.delegate.impl; - -import plugin.doc.generate.checker.impl.EditorAvailableChecker; -import plugin.doc.generate.checker.impl.JavaFileChecker; -import plugin.doc.generate.checker.impl.SpringControllerChecker; -import plugin.doc.generate.delegate.GeneratorDelegate; - -public class ControllerDocumentDelegate extends GeneratorDelegate { - - public ControllerDocumentDelegate() { - this.addChecker(new EditorAvailableChecker()); - this.addChecker(new JavaFileChecker()); - this.addChecker(new SpringControllerChecker()); - } - -} diff --git a/src/plugin/doc/generate/delegate/impl/DefaultDelegateFactory.java b/src/plugin/doc/generate/delegate/impl/DefaultDelegateFactory.java deleted file mode 100644 index 281db69..0000000 --- a/src/plugin/doc/generate/delegate/impl/DefaultDelegateFactory.java +++ /dev/null @@ -1,6 +0,0 @@ -package plugin.doc.generate.delegate.impl; - -import plugin.doc.generate.delegate.GeneratorDelegate; - -public class DefaultDelegateFactory extends GeneratorDelegate { -}