Merge pull request #41 from shalousun/master

update: 3.0.0 release, change groupId
smart-doc-group · Oct 20, 2023 · b623e56 · b623e56
2 parents 6b0db18 + dfe7a65
commit b623e56
Show file tree

Hide file tree

Showing 18 changed files with 127 additions and 123 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 ## smart-doc
 
 
-![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc)
+![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc)
 [![License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 ![number of issues closed](https://img.shields.io/github/issues-closed-raw/smart-doc-group/smart-doc)
 ![closed pull requests](https://img.shields.io/github/issues-pr-closed/smart-doc-group/smart-doc)

diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -1,5 +1,5 @@
 
-# smart-doc <small> ![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc) </small>
+# smart-doc <small> ![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc) </small>
 
 
 > A non-intrusive api interface document generator.

diff --git a/docs/diy/advancedFeatures.md b/docs/diy/advancedFeatures.md
@@ -292,13 +292,13 @@ Let's first look at how to use the classifier to load the source code package.
 <dependency>
      <groupId>com.github.shalousun</groupId>
      <artifactId>common-util</artifactId>
-     <version>1.8.6</version>
+     <version>2.1.1</version>
 </dependency>
 <!--Depending on the library source code, plug-ins using smart-doc do not need to use this method to load sources-->
 <dependency>
      <groupId>com.github.shalousun</groupId>
      <artifactId>common-util</artifactId>
-     <version>1.8.6</version>
+     <version>2.1.1</version>
      <classifier>sources</classifier>
      <!--Set to test, the source will not be put into the final product package when the project is released-->
      <scope>test</scope>

diff --git a/docs/diy/config.md b/docs/diy/config.md
@@ -876,7 +876,7 @@ Whether to display the response parameter table in the document.
 * required: `false`
 * type:`String`
 * default: `RANDOM`
-* @since `2.7.8` :new:
+* @since `3.0.0` :new:
 
 openapi component key generator RANDOM :  support @Validated NORMAL: don't support @Validated, for openapi generator
 ```json

diff --git a/docs/diy/highlight.md b/docs/diy/highlight.md
diff --git a/docs/en/dubbo/dubbo.md b/docs/en/dubbo/dubbo.md
@@ -12,7 +12,7 @@ Let's look at the integration method.
 Add smart-doc-maven-plugin to your dubbo service api or dubbo provider module. Of course you only need to select one method
 ```xml
 <plugin>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[Latest version]</version>
     <configuration>
@@ -23,7 +23,7 @@ Add smart-doc-maven-plugin to your dubbo service api or dubbo provider module. O
         <!--smart-doc realizes automatic analysis of the dependency tree to load the source code of third-party dependencies. If some framework dependency libraries cannot be loaded and cause an error, please use excludes to exclude -->
         <excludes>
             <!--The format is: groupId:artifactId; reference is as follows-->
-            <!- Starting from version 1.0.7, you can also use regular matching to exclude, such as: poi.* -->
+            <!-- Starting from version 1.0.7, you can also use regular matching to exclude, such as: poi.* -->
             <exclude>com.alibaba:fastjson</exclude>
         </excludes>
         <!--Since version 1.0.8, the plugin provides includes support-->

diff --git a/docs/start/javadoc.md b/docs/start/javadoc.md
@@ -2,11 +2,11 @@
 
 The original intention of smart-doc is to remove the intrusion of annotations by using javadoc document comments. Therefore, every additional function of smart-doc is to consider the native tags of javadoc. The following is an introduction to some javadoc tags used by smart-doc. .
 
-|  tag name   |  description   |
-| --- | --- |
-|  @param  | For the Spring Boot interface layer, for simple type parameters, you must write a comment description when using @param, and for Entity type smart-doc, it will not be checked.    |
-|  @deprecated  |Can be used in comments to mark that the interface is obsolete, and the effect is the same as the @Deprecated annotation|
-|  @apiNote | @apiNote is a new document tag for java, smart-doc uses @apiNote as a detailed description of the method, so you can use apiNote to write a long note. If a method does not write @apiNote annotation description, smart-doc directly uses the method default annotation to fill in|
+| tag name    | description                                                                                                                                                                                                                                                                         |
+|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| @param      | For the Spring Boot interface layer, for simple type parameters, you must write a comment description when using @param, and for Entity type smart-doc, it will not be checked.                                                                                                     |
+| @deprecated | Can be used in comments to mark that the interface is obsolete, and the effect is the same as the @Deprecated annotation                                                                                                                                                            |
+| @apiNote    | @apiNote is a new document tag for java, smart-doc uses @apiNote as a detailed description of the method, so you can use apiNote to write a long note. If a method does not write @apiNote annotation description, smart-doc directly uses the method default annotation to fill in |
 
 
 # javadoc Usage
@@ -113,11 +113,11 @@ In the future, @ignore will only be used in method and class comments.
 
 In the Controller layer, use SubUser as a parameter to receive, and the parameter request document output by smart-doc:
 
-| Parameter | Type | Description | Required |
-| --- | --- | --- | --- |
-| subUserName | string | user name | false |
-| idCard | string | ID card | false |
-| gender | int | gender | false|
+| Parameter   | Type   | Description | Required |
+|-------------|--------|-------------|----------|
+| subUserName | string | user name   | false    |
+| idCard      | string | ID card     | false    |
+| gender      | int    | gender      | false    |
 
 ## 2.2 @mock use
 

diff --git a/docs/start/quickstart.md b/docs/start/quickstart.md
@@ -21,7 +21,7 @@ For multi-module maven, put the smart-doc plug-in configuration into the pom of
 
 ```xml
 <plugin>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[latest]</version>
     <configuration>
@@ -106,7 +106,7 @@ The official provides an example of SpringBoot integrating smart-doc to generate
 Using the plugins DSL:
 ```gradle
 plugins {
-  id "com.github.shalousun.smart-doc" version "[latest]"
+  id "com.ly.smart-doc" version "[latest]"
 }
 ```
 
@@ -119,10 +119,10 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.github.shalousun:smart-doc-gradle-plugin:[latest]'
+        classpath 'com.ly.smart-doc:smart-doc-gradle-plugin:[latest]'
     }
 }
-apply(plugin = "com.github.shalousun.smart-doc")
+apply(plugin = "com.ly.smart-doc")
 ```
 
 **Plug-in configuration items**
@@ -155,7 +155,7 @@ smartdoc {
 For multi-module gradle, put the smart-doc plug-in configuration into subprojects of the root directory build.gradle.
 ```
 subprojects{
-    apply plugin: 'com.github.shalousun.smart-doc'
+    apply plugin: 'com.ly.smart-doc'
     smartdoc {
         //
         configFile = file("src/main/resources/smart-doc.json")

diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md
@@ -1,7 +1,7 @@
 ## smart-doc
 
 
-![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc)
+![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc)
 [![License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 ![number of issues closed](https://img.shields.io/github/issues-closed-raw/smart-doc-group/smart-doc)
 ![closed pull requests](https://img.shields.io/github/issues-pr-closed/smart-doc-group/smart-doc)

diff --git a/docs/zh-cn/_coverpage.md b/docs/zh-cn/_coverpage.md
@@ -1,5 +1,5 @@
 
-# smart-doc <small> ![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc) </small>
+# smart-doc <small> ![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc) </small>
 
 
 > 一个无侵入式的api接口文档生成器.

diff --git a/docs/zh-cn/community/developer.md b/docs/zh-cn/community/developer.md
@@ -9,7 +9,7 @@ smart-doc社区包含Maintainer、Committer、Contributor等角色，每种角
 成为 Maintainer 的标准：
 - 完成多个关键核心功能模块设计与开发，是项目的核心开发人员；
 - 持续的投入和激情，能够积极参与社区、官网、Issue、Pull Request(PR) 、Discussion 等项目相关事项的维护；
-- 在社区中具有非常好的影响力。
+- 在社区中具有非常好的影响力，能够代表社区对外做一些分享。
 
 成为Maintainer，您也将获得如下权利：
 - 具有Smart-doc GitHub 仓库管理权限。
@@ -19,14 +19,18 @@ smart-doc社区包含Maintainer、Committer、Contributor等角色，每种角
 是对smart-doc社区某些特定领域做出突出贡献的人 
 
 成为Committer的标准：
-- 能够长时间地并持续性地贡献Issue、PR 代码、测试用例、文档、案例)，社区贡献10个及以上PR；
+- 能够长时间地并持续性地贡献Issue、PR 代码、测试用例、文档、案例)，社区贡献10个及以上高质量PR；
 - 参与重要 Feature 的讨论、设计、开发、测试；
 - 参与 Code Review。
 
 成为Committer，您也将获得如下权利：
 - 具有smart-doc GitHub仓库write权限。
 - 参与smart-doc演进、发展的讨论，及核心模块设计评审等。
 
+成为Committer，您将获得的奖励：
+- 社区官网对Committer做展示。
+- 社区文化衫或其他礼品奖励。
+
 ## Contributor
 是对smart-doc项目有贡献的个人。
 
@@ -44,7 +48,7 @@ smart-doc社区包含Maintainer、Committer、Contributor等角色，每种角
 > 注：排名不分先后。如有遗漏，请提交 PR 添加。
 
 ## PMC(项目管理委员会，Project Management Committee)
-- Yu Sun(@shalousun)
+- Yu Sun([@shalousun](https://github.com/shalousun))
 
 ## Committer
 社区目前处理迁移建设中，等待社区文档完善后评审。

diff --git a/docs/zh-cn/dubbo/dubbo.md b/docs/zh-cn/dubbo/dubbo.md
@@ -14,7 +14,7 @@
 在你的`dubbo api`或者或者是`dubbo provider`模块中添加`smart-doc-maven-plugin`。当然你只需要选中一种方式即可
 ```xml
 <plugin>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[最新版本]</version>
     <configuration>

diff --git a/docs/zh-cn/faq.md b/docs/zh-cn/faq.md
@@ -25,7 +25,7 @@
 提升速度最直接的方式就是在插件中配置：`include`或者`exclude` 。例如：
 ```xml
 <plugin>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[最新版本]</version>
     <configuration>

diff --git a/docs/zh-cn/plugins/gradle_plugin.md b/docs/zh-cn/plugins/gradle_plugin.md
@@ -13,7 +13,7 @@
 Using the plugins DSL:
 ```gradle
 plugins {
-  id "com.github.shalousun.smart-doc" version "[最新版本]"
+  id "com.ly.smart-doc" version "[最新版本]"
 }
 ```
 #### Using legacy plugin application
@@ -33,10 +33,10 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.github.shalousun:smart-doc-gradle-plugin:[最新版本]'
+        classpath 'com.ly.smart-doc:smart-doc-gradle-plugin:[最新版本]'
     }
 }
-apply(plugin = "com.github.shalousun.smart-doc")
+apply(plugin = "com.ly.smart-doc")
 ```
 
 **`buildscript`配置添加到`build.gradle`的顶部** 。
@@ -67,7 +67,7 @@ smartdoc {
 
 ```gradle
 subprojects{
-    apply plugin: 'com.github.shalousun.smart-doc'
+    apply plugin: 'com.ly.smart-doc'
     smartdoc {
         //
         configFile = file("src/main/resources/smart-doc.json")
@@ -239,7 +239,7 @@ gradle tornaRpc
 ![idea中smart-doc-gradle插件使用](../../_images/idea-gradle-plugin.png "usage.png")
 
 # 插件源码
-https://gitee.com/smart-doc-team/smart-doc-gradle-plugin
+https://github.com/TongchengOpenSource/smart-doc-gradle-plugin
 
 # gradle多模块构建配置参考
 [【smart-doc-gradle-plugin集成demo】](https://gitee.com/smart-doc-team/smart-doc-gradle-plugin-demo)
diff --git a/docs/zh-cn/plugins/gradle_plugin_debug.md b/docs/zh-cn/plugins/gradle_plugin_debug.md
@@ -12,7 +12,7 @@
 添加`smart-doc`依赖主要是方便直接查看到源码调试。未发生错误，不需要调试事并不需要在自己的项目中添加`smart-doc`依赖。
 ```
 dependencies {
-    testCompile 'com.github.shalousun:smart-doc:【最新版本】'
+    testCompile 'com.ly.smart-doc:smart-doc:【最新版本】'
 }
 ```
 找到`smart-doc`源码打上断点。操作如下图：

diff --git a/docs/zh-cn/plugins/maven-plugin-debug.md b/docs/zh-cn/plugins/maven-plugin-debug.md
@@ -11,7 +11,7 @@
 
 ```
 <dependency>
-     <groupId>com.github.shalousun</groupId>
+     <groupId>com.ly.smart-doc</groupId>
      <artifactId>smart-doc</artifactId>
      <version>[最新版本]</version>
      <scope>test</scope>
@@ -32,7 +32,7 @@
 
 ```
 <dependency>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>【maven仓库最新版本】</version>
 </dependency>

diff --git a/docs/zh-cn/plugins/maven_plugin.md b/docs/zh-cn/plugins/maven_plugin.md
@@ -22,7 +22,7 @@
 
 ```xml
 <plugin>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[最新版本]</version>
     <configuration> 

diff --git a/docs/zh-cn/start/quickstart.md b/docs/zh-cn/start/quickstart.md
@@ -22,7 +22,7 @@
 
 ```xml
 <plugin>
-    <groupId>com.github.shalousun</groupId>
+    <groupId>com.ly.smart-doc</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>[最新版本]</version>
     <configuration> 
@@ -102,7 +102,7 @@ mvn clean install -Dmaven.test.skip=true
 ### Using the plugins DSL:
 ```gradle
 plugins {
-  id "com.github.shalousun.smart-doc" version "[最新版本]"
+  id "com.ly.smart-doc" version "[最新版本]"
 }
 ```
 
@@ -122,10 +122,10 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.github.shalousun:smart-doc-gradle-plugin:[最新版本]'
+        classpath 'com.ly.smart-doc:smart-doc-gradle-plugin:[最新版本]'
     }
 }
-apply(plugin = "com.github.shalousun.smart-doc")
+apply(plugin = "com.ly.smart-doc")
 ```
 
 **插件配置项**
@@ -158,7 +158,7 @@ smartdoc {
 对于多模块的`Gradle`，把`smart-doc`插件相关配置放到根目录`build.gradle`的`subprojects`中。
 ```gradle
 subprojects{
-    apply plugin: 'com.github.shalousun.smart-doc'
+    apply plugin: 'com.ly.smart-doc'
     smartdoc {
         //
         configFile = file("src/main/resources/smart-doc.json")