Skip to content

Commit

Permalink
Merge pull request #151 from shalousun/master
Browse files Browse the repository at this point in the history
fix: spi interface usage desc error
  • Loading branch information
shalousun authored Dec 31, 2024
2 parents 7250e3c + 78ec080 commit c35f09b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/en/guide/advanced/expand.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Create a new module or project and include the `smart-doc` dependency:
</project>
```

Implement the `com.power.doc.spi.DocBuildTemplate` interface. If you want to obtain `WebSocket` documentation, implement the `com.ly.doc.template.IWebSocketDocBuildTemplate` interface and implement the relevant methods.
Implement the `com.ly.doc.template.IDocBuildTemplate` interface. If you want to obtain `WebSocket` documentation, implement the `com.ly.doc.template.IWebSocketDocBuildTemplate` interface and implement the relevant methods.

For example:
```java
Expand Down Expand Up @@ -278,7 +278,7 @@ public class QuarkusDocBuildTemplate implements IDocBuildTemplate<ApiDoc> {
}
```

Then add the fully qualified name of the implementation class to the `resources/META-INF/services/com.ly.doc.spi.DocBuildTemplate` file.
Then add the fully qualified name of the implementation class to the `resources/META-INF/services/com.ly.doc.template.IDocBuildTemplate` file.
If it is a `WebSocket` document, add the fully qualified name of the implementation class to the `resources/META-INF/services/com.ly.doc.template.IWebSocketDocBuildTemplate` file.

As shown below:
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/guide/advanced/expand.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Dubbo`层面的解析。由于官方开源人力有限,因此无法去满足
</dependencies>
</project>
```
实现`com.power.doc.spi.DocBuildTemplate`接口,如果要获取`WebSocket`文档,则实现`com.ly.doc.template.IWebSocketDocBuildTemplate`接口,并实现相关方法,
实现`com.power.doc.template.IDocBuildTemplate`接口,如果要获取`WebSocket`文档,则实现`com.ly.doc.template.IWebSocketDocBuildTemplate`接口,并实现相关方法,
示例代码如下:
```java
package com.github.test;
Expand Down Expand Up @@ -310,7 +310,7 @@ public class QuarkusDocBuildTemplate implements IDocBuildTemplate<ApiDoc> {

```

然后在 `resources/META-INF/services/com.ly.doc.spi.DocBuildTemplate` 文件中添加实现类的全类名。如果是`WebSocket`文档则在`resources/META-INF/services/com.ly.doc.template.IWebSocketDocBuildTemplate` 文件中添加实现类的全类名。
然后在 `resources/META-INF/services/com.ly.doc.template.IDocBuildTemplate` 文件中添加实现类的全类名。如果是`WebSocket`文档则在`resources/META-INF/services/com.ly.doc.template.IWebSocketDocBuildTemplate` 文件中添加实现类的全类名。

如下图所示:
![project](/assets/project-screenshots.png)
Expand Down

0 comments on commit c35f09b

Please sign in to comment.