You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by GitBox <gi...@apache.org> on 2022/07/16 14:36:48 UTC

[GitHub] [shardingsphere] terrymanu commented on a diff in pull request #19270: Update encrypt.en.md

terrymanu commented on code in PR #19270:
URL: https://github.com/apache/shardingsphere/pull/19270#discussion_r922686623


##########
docs/document/content/dev-manual/encrypt.en.md:
##########
@@ -5,20 +5,22 @@ weight = 12
 chapter = true
 +++
 
-## SPI Interface
+## EncryptAlgorithm
 
-| SPI Name         | Description            |
-| ---------------- | ---------------------- |
-| EncryptAlgorithm | Data encrypt algorithm |
+### Fully-qualified class name
 
-## Sample
+[`org.apache.shardingsphere.encrypt.algorithm`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-api/src/main/java/org/apache/shardingsphere/encrypt/spi/EncryptAlgorithm.java)

Review Comment:
   Only package name is not enough, please add class name



##########
docs/document/content/dev-manual/encrypt.en.md:
##########
@@ -5,20 +5,22 @@ weight = 12
 chapter = true
 +++
 
-## SPI Interface
+## EncryptAlgorithm
 
-| SPI Name         | Description            |
-| ---------------- | ---------------------- |
-| EncryptAlgorithm | Data encrypt algorithm |
+### Fully-qualified class name
 
-## Sample
+[`org.apache.shardingsphere.encrypt.algorithm`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-api/src/main/java/org/apache/shardingsphere/encrypt/spi/EncryptAlgorithm.java)
 
-### EncryptAlgorithm
+### Definition
 
-| *Implementation Class*        | *Description*              |
-| ----------------------------- | -------------------------- |
-| MD5EncryptAlgorithm           | MD5 data encrypt algorithm |
-| AESEncryptAlgorithm           | AES data encrypt algorithm |
-| RC4EncryptAlgorithm           | RC4 data encrypt algorithm |
-| SM3EncryptAlgorithm           | SM3 data encrypt algorithm |
-| SM4EncryptAlgorithm           | SM4 data encrypt algorithm |
+Data encryption algorithm definition
+
+### Implementation classes
+
+| *Configuration Type* | *Description*                             | *Fully-qualified class name* |
+| -------------------- | ----------------------------------------- | ---------------------------- |
+| MD5EncryptAlgorithm           | MD5 data encrypt algorithm | [`org.apache.shardingsphere.encryption.algorithm.MD5Encrypt`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/MD5EncryptAlgorithm.java) |

Review Comment:
   MD5EncryptAlgorithm should be MD5, please reference the `getType` of source code. Other rows are same



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org