Merge pull request #152 from linwumingshi/fix/expand-info

docs(guide): update QuarkusDocBuildTemplate example
smart-doc-group · Jan 5, 2025 · 51bd5c7 · 51bd5c7
2 parents c35f09b + d46ed1a
commit 51bd5c7
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 17 deletions.
diff --git a/docs/en/guide/advanced/expand.md b/docs/en/guide/advanced/expand.md
@@ -103,7 +103,7 @@ The field information is as follows:
 
 
 
-## Other framework document parsing and development
+## ~~Other framework document parsing and development~~
 :::warning
 `@since 3.0.6`, you don't need to modify the source code~
 :::
@@ -256,21 +256,47 @@ import java.util.Collection;
  */
 public class QuarkusDocBuildTemplate implements IDocBuildTemplate<ApiDoc> {
 
+    /**
+     * render api
+     *
+     * @param projectBuilder   ProjectDocConfigBuilder
+     * @param candidateClasses candidate classes
+     * @return api ApiSchema
+     */
     @Override
     public ApiSchema<ApiDoc> renderApi(ProjectDocConfigBuilder projectBuilder, Collection<JavaClass> candidateClasses) {
         return null;
     }
 
+    /**
+     * support framework.
+     *
+     * @param framework framework
+     * @return boolean
+     */
     @Override
     public boolean supportsFramework(String framework) {
+        // match Quarkus
         return "Quarkus".equalsIgnoreCase(framework);
     }
 
+    /**
+     * registered annotations.
+     *
+     * @return registered annotations
+     */
     @Override
     public FrameworkAnnotations registeredAnnotations() {
         return null;
     }
 
+    /**
+     * is entry point.
+     *
+     * @param javaClass            javaClass
+     * @param frameworkAnnotations frameworkAnnotations
+     * @return is entry point
+     */
     @Override
     public boolean isEntryPoint(JavaClass javaClass, FrameworkAnnotations frameworkAnnotations) {
         return false;

diff --git a/docs/zh/guide/advanced/expand.md b/docs/zh/guide/advanced/expand.md
@@ -238,7 +238,7 @@ Dubbo`层面的解析。由于官方开源人力有限，因此无法去满足
     </dependencies>
 </project>
  ```
-实现`com.power.doc.template.IDocBuildTemplate`接口，如果要获取`WebSocket`文档，则实现`com.ly.doc.template.IWebSocketDocBuildTemplate`接口，并实现相关方法, 
+实现`com.ly.doc.template.IDocBuildTemplate`接口，如果要获取`WebSocket`文档，则实现`com.ly.doc.template.IWebSocketDocBuildTemplate`接口，并实现相关方法, 
 示例代码如下：
 ```java
 package com.github.test;
@@ -253,7 +253,7 @@ import com.thoughtworks.qdox.model.JavaClass;
 import java.util.Collection;
 
 /**
- * QuarkusDocBuildTemplate.
+ * QuarkusDocBuildTemplate 类，用于生成 Quarkus 项目的 API 文档。
  *
  * @author test
  * @version 1.0.0
@@ -262,45 +262,45 @@ import java.util.Collection;
 public class QuarkusDocBuildTemplate implements IDocBuildTemplate<ApiDoc> {
 
     /**
-     * render api
+     * 渲染 API 文档
      *
-     * @param projectBuilder   ProjectDocConfigBuilder
-     * @param candidateClasses candidate classes
-     * @return api ApiSchema
+     * @param projectBuilder   项目文档配置构建器
+     * @param candidateClasses 候选的 Java 类集合
+     * @return 返回生成的 API 文档架构
      */
     @Override
     public ApiSchema<ApiDoc> renderApi(ProjectDocConfigBuilder projectBuilder, Collection<JavaClass> candidateClasses) {
         return null;
     }
 
     /**
-     * support framework.
+     * 判断是否支持指定的框架
      *
-     * @param framework framework
-     * @return boolean
+     * @param framework 框架名称
+     * @return 如果支持该框架则返回 true，否则返回 false
      */
     @Override
     public boolean supportsFramework(String framework) {
-        // 匹配
+        // 匹配 Quarkus 框架
         return "Quarkus".equalsIgnoreCase(framework);
     }
 
     /**
-     * registered annotations.
+     * 获取已注册的注解
      *
-     * @return registered annotations
+     * @return 返回框架支持的注解
      */
     @Override
     public FrameworkAnnotations registeredAnnotations() {
         return null;
     }
 
     /**
-     * is entry point.
+     * 判断给定的 Java 类是否为入口点
      *
-     * @param javaClass            javaClass
-     * @param frameworkAnnotations frameworkAnnotations
-     * @return is entry point
+     * @param javaClass            Java 类
+     * @param frameworkAnnotations 框架注解
+     * @return 如果是入口点返回 true，否则返回 false
      */
     @Override
     public boolean isEntryPoint(JavaClass javaClass, FrameworkAnnotations frameworkAnnotations) {