Update Documents

xterao · xterao · commit 00899bd7c187 · 2025-08-07T13:34:46.000+09:00
diff --git a/README.md b/README.md
@@ -42,6 +42,8 @@ The plugin also provides quick fixes for DAO methods where the required SQL file
   ![returnTypeInspection.png](images/returnTypeInspection.png)
 - Checks that parameters of DAO method matches the expected type based on its annotation.
   ![paramTypeInspection.png](images/paramTypeInspection.png)
+- Checks the validity of `include` and `exclude` options in `@Update`, `@BatchUpdate`, `@Insert`, `@BatchInsert`,`@MultiInsert`  and `@Returning`annotations:
+  ![inspectionAnnotationOptions.png](images/inspectionAnnotationOptions.png)
 - Checks for undefined bind variable names.
 - Checks the class name and package name for static property calls.
   ![inspectionPackageName.png](images/inspectionPackageName.png)
diff --git a/images/inspectionAnnotationOptions.png b/images/inspectionAnnotationOptions.png
diff --git a/src/main/resources/inspectionDescriptions/org.domaframework.doma.intellij.annotation.option.html b/src/main/resources/inspectionDescriptions/org.domaframework.doma.intellij.annotation.option.html
@@ -0,0 +1,10 @@
+<html lang="en">
+<body>
+<p>
+Reports when a property name specified in the <code>include</code> or <code>exclude</code> option of a Doma annotations(such as <code>@Update</code> or <code>@BatchInsert</code>) on a DAO method does not exist in the corresponding Entity class parameter.
+</p>
+<p>
+If the <code>returning</code> option is specified, the inspection also checks the property names listed in the <code>include</code> and <code>exclude</code> options within the <code>Returning</code> annotation.
+</p>
+</body>
+</html>
