add IdGenerator implementation class diagram

xinyuranyan · Feb 22, 2022 · fa5fe57 · fa5fe57
1 parent fb3c847
commit fa5fe57
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/document/docs/.vuepress/public/assets/design/IdGenerator-impl-class.png b/document/docs/.vuepress/public/assets/design/IdGenerator-impl-class.png
diff --git a/document/docs/guide/api/README.md b/document/docs/guide/api/README.md
@@ -3,9 +3,10 @@
 > **分布式ID**生成器
 
 ```java
+
 @ThreadSafe
 public interface IdGenerator {
-
+    
     /**
      * ID converter, used to convert {@link long} type ID to {@link String}
      *
@@ -14,14 +15,14 @@ public interface IdGenerator {
     default IdConverter idConverter() {
         return ToStringIdConverter.INSTANCE;
     }
-
+    
     /**
      * Generate distributed ID
      *
      * @return distributed ID
      */
     long generate();
-
+    
     /**
      * Generate distributed ID as String
      *
@@ -33,3 +34,8 @@ public interface IdGenerator {
 }
 ```
 
+## IdGenerator implementation class diagram
+
+<p align="center">
+  <img :src="$withBase('/assets/design/IdGenerator-impl-class.png')" alt="IdGenerator implementation class diagram"/>
+</p>