Merge pull request #114 from shalousun/master

docs: add use case
smart-doc-group · Sep 7, 2024 · a223485 · a223485
2 parents 7b037f0 + 7ee1253
commit a223485
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 14 deletions.
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
@@ -41,6 +41,9 @@ function nav(): DefaultTheme.NavItem[] {
                 },{
                     text: 'Documenting a Spring REST API Using Smart-doc',
                     link: 'https://dzone.com/articles/documenting-a-spring-rest-api-using-smart-doc',
+                },{
+                    text: 'Documenting a Java WebSocket API Using Smart-Doc',
+                    link: 'https://dzone.com/articles/generate-java-websocket-api-documentation-using-smart-doc',
                 }
             ],
         },

diff --git a/docs/en/guide/community/developer.md b/docs/en/guide/community/developer.md
@@ -1,8 +1,12 @@
 # Community Roles
-The `smart-doc` community includes roles such as `Maintainer`, `Committer`, and `Contributor`, with the following standard definitions for each role.
+
+The `smart-doc` community includes roles such as `Maintainer`, `Committer`, and `Contributor`, with the following
+standard definitions for each role.
 
 ## The smart-doc Development Team
-Thank you to all the developers for your contributions to the community! We will regularly showcase all contributors' names, and you can also submit a `PR` to add yourself.
+
+Thank you to all the developers for your contributions to the community! We will regularly showcase all contributors'
+names, and you can also submit a `PR` to add yourself.
 > Note: The ranking is not in order of priority. If there are any omissions, please submit a PR to add.
 
 <script setup>
@@ -41,51 +45,73 @@ const members = [
       { icon: 'github', link: 'https://github.com/abing22333' },
     ]
   },
+  {
+    avatar: 'https://github.com/linwumingshi.png',
+    name: 'Linwumingshi',
+    title: 'Committer',
+    links: [
+      { icon: 'github', link: 'https://github.com/linwumingshi' },
+    ]
+  },
+
 ]
 </script>
 
 <VPTeamMembers size="small" :members="members" />
 
 ## Contributor
-https://github.com/TongchengOpenSource/smart-doc/graphs/contributors
 
+https://github.com/TongchengOpenSource/smart-doc/graphs/contributors
 
 ## Maintainer
+
 Individuals who have made significant contributions to the evolution and development of the `smart-doc` project.
 
 Criteria for becoming a `Maintainer`:
+
 - Completed the design and development of multiple key core functional modules, being a core developer of the project;
-- Consistent dedication and passion, actively participating in community maintenance related to the official website, `Issues`, `Pull Requests(PR)`, `Discussions`, etc.;
+- Consistent dedication and passion, actively participating in community maintenance related to the official
+  website, `Issues`, `Pull Requests(PR)`, `Discussions`, etc.;
 - Have a good influence in the community and can represent the community to share knowledge externally.
 
 As a `Maintainer`, you will also gain the following rights:
+
 - Manage permissions for the `Smart-doc GitHub` repository.
 - Participate in the nomination and voting for new `Committer` or `Maintainer`.
 
 ## Committer
+
 Individuals who have made outstanding contributions in certain specific areas of the `smart-doc` community
 
 Criteria for becoming a `Committer`:
-- Able to contribute `Issues`, `PR` code, test cases, documentation, cases, etc., over a long period and consistently, with more than 10 high-quality `PR` contributions to the community;
+
+- Able to contribute `Issues`, `PR` code, test cases, documentation, cases, etc., over a long period and consistently,
+  with more than 10 high-quality `PR` contributions to the community;
 - Participate in discussions, design, development, and testing of important `Features`;
 - Participate in `Code Review`.
 
 As a `Committer`, you will also gain the following rights:
+
 - Write permissions for the `smart-doc GitHub` repository.
 - Participate in discussions about the evolution and development of `smart-doc`, and review the design of core modules.
 
 Rewards for becoming a `Committer`:
+
 - Display of `Committer` on the community official website.
 - Community t-shirts or other gift rewards.
 
 ## Contributor
+
 Individuals who have contributed to the `smart-doc` project.
 
 Criteria for becoming a `Contributor`:
+
 - Submitted a `PR` that has been merged, including but not limited to documentation, code, cases, etc.;
 - Participated in related issue discussions in the `smart-doc` open source community and actively responded.
 
 How to become a Contributor and Committer
 Anyone who is interested in the `smart-doc` project can become a `Contributor` of the `smart-doc` project.
-You can start participating in community contributions by contributing to the documentation and gradually get involved in code contributions.
-If you have become a `Smart-doc Contributor` and continue to contribute, reaching the requirements of a `Committer`, we will invite you to become a `Smart-doc Committer`.
+You can start participating in community contributions by contributing to the documentation and gradually get involved
+in code contributions.
+If you have become a `Smart-doc Contributor` and continue to contribute, reaching the requirements of a `Committer`, we
+will invite you to become a `Smart-doc Committer`.
diff --git a/docs/en/guide/javadoc.md b/docs/en/guide/javadoc.md
@@ -2,10 +2,10 @@
 
 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 |
+| 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 |
 
 
@@ -70,7 +70,7 @@ There are relatively few native Javadoc tags in Java, which cannot meet some usa
 | @download                 | @since smart-doc 2.0.1, the download tag is used to mark the file download method of the controller, and the file download test can be realized when the debug page is generated. And it supports to download the file with request header parameter test.                                                                                                                                                                                                                                                                                                                                         |
 | @page                     | @since smart-doc 2.0.2, the page tag is used to mark the controller method to indicate that the method is used to render and return a static page. If a test is initiated when the debug page is generated, the test page will automatically be opened in the browser. Label display page.                                                                                                                                                                                                                                                                                                         |
 | @ignoreParams             | @since smart-doc 2.1.0, ignoreParams tag is used to mark the parameters that do not want to be displayed in the document on the controller method, for example: @ignoreParams id name, multiple parameter names are separated by spaces                                                                                                                                                                                                                                                                                                                                                            |
-| @response                 | @since smart-doc 2.2.0, the response tag is marked on the controller method to allow you to define the returned json example by yourself. It is recommended to use it only when returning basic types, such as: `Result<String>` This generic type is a response of a simple primitive type.                                                                                                                                                                                                                                                                                                         |
+| @response                 | @since smart-doc 2.2.0, the response tag is marked on the controller method to allow you to define the returned json example by yourself. It is recommended to use it only when returning basic types, such as: `Result<String>` This generic type is a response of a simple primitive type.                                                                                                                                                                                                                                                                                                       |
 | @tag                      | @since 2.2.5, @tag is used to classify controller methods. You can assign methods under different controllers to multiple categories, and you can also directly assign controllers to one category or multiple categories.                                                                                                                                                                                                                                                                                                                                                                         |
 | @extension                | @since 3.0.3, @extension is marked on the controller method. it's used to support the extension feature of OpenApi. it will add a "x-*" attribution for openapi.json                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
@@ -117,7 +117,7 @@ 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    |

diff --git a/docs/en/guide/use-cases.md b/docs/en/guide/use-cases.md
@@ -1,3 +1,4 @@
 # Smart-doc Community User Case Practices
 - [How To Use Smart-Doc To Generate JMeter Scripts](https://dzone.com/articles/how-to-use-smart-doc-to-generate-jmeter-test-scripts)
-- [Documenting a Spring REST API Using Smart-doc](https://dzone.com/articles/documenting-a-spring-rest-api-using-smart-doc)
+- [Documenting a Spring REST API Using Smart-doc](https://dzone.com/articles/documenting-a-spring-rest-api-using-smart-doc)
+- [Documenting a Java WebSocket API Using Smart-Doc](https://dzone.com/articles/generate-java-websocket-api-documentation-using-smart-doc)
diff --git a/docs/zh/guide/community/developer.md b/docs/zh/guide/community/developer.md
@@ -41,6 +41,14 @@ const members = [
       { icon: 'github', link: 'https://github.com/abing22333' },
     ]
   },
+  {
+    avatar: 'https://github.com/linwumingshi.png',
+    name: 'Linwumingshi',
+    title: 'Committer',
+    links: [
+      { icon: 'github', link: 'https://github.com/linwumingshi' },
+    ]
+  },
 ]
 </script>