@@ -19,46 +19,45 @@ Shortcut keys can be used for actions
1919![ FileJump.gif] ( images/gif/FileJump.gif )
2020
2121- ** Jump to SQL**
22- - Jump to action from DAO to SQL
22+ - Jump to from DAO to SQL
2323 - You can also jump to the SQL file from the gutter icon that is displayed together.
2424- ** Generate SQL**
2525 - Generate SQL file
2626- ** Jump to DAO**
27- - Jump to action from SQL to DAO
27+ - Jump to from SQL to DAO
2828 - You can also jump to the DAO Method from the gutter icon that is displayed together.
2929
3030## Inspection
3131Check that bind variables are used appropriately for DAO and SQL associations.
3232The plugin also provides quick fixes for DAO methods where the required SQL files do not exist.
3333
34- - Quick fix for missing SQL template file
34+ - Quick fix for generateSQL template file.
3535 ![ quickfix.png] ( images/quickfix.png )
36- - Checking for DAO method arguments not used in bind variables
36+ - Checking for DAO method arguments not used.
3737 ![ inspection.png] ( images/inspection.png )
38- - Check the class name and package name for static property calls
38+ - Check for undefined bind variable names.
39+ - Check the class name and package name for static property calls.
3940 ![ inspectionPackageName.png] ( images/inspectionPackageName.png )
40- - Optional types are recognized as their element type (e.g. Optional<String > is treated as String).
41- - Checks calls to custom functions and error-highlights any methods that aren’t defined in the classes registered via the settings .
41+ - Optional types are recognized as their element type (e.g. a parameter of type ` Optional<String> ` is treated as type ` String ` ).
42+ - For custom functions, checks for methods that are not defined in the configured ExpressionFunctions implementation class .
4243
4344## Completion
44- Adds code completion functionality to support indexing of Doma directives and bind variables
45+ Code completion is available to assist you in coding the bind variable names within the directives.
4546
46- - Suggest DAO method arguments in bind variable directives
47+ - Suggest DAO method arguments in bind variable directives.
4748 ![ Completion.gif] ( images/gif/Completion.gif )
48- - Refer to class definition from DAO method argument type and suggest fields and methods
49- - Provide code completion for class and package names used in static property calls.
49+ - Refer to class definition from DAO method argument type and suggest fields and methods.
50+ - Provide code completion for class names used in static property calls.
5051 ![ CompletionStatic.gif] ( images/gif/CompletionStatic.gif )
51- - Suggest members defined as static in static fields and method calls
52- - Suggest Doma directives
53- - Directives such as Condition, Loop, Population are suggested after “%”
54- - Suggest built-in functions after “@”
55- - Optional types are recognized as their element type (e.g. Optional<String > is treated as String).
56- - Suggest functions during code completion from the ExpressionFunctions implementation classes registered in the settings.
52+ - Suggest members defined as static in static fields and method calls.
53+ - Directives such as Condition, Loop, Population are suggested after ` % ` .
54+ - Suggests built-in and custom functions after ` @ ` .
55+ - Optional types are recognized as their element type (e.g. a parameter of type ` Optional<String> ` is treated as type ` String ` ).
5756
5857## Refactoring
59- Along with the DAO name change, we will refactor the SQL file directory and file name.
58+ Along with the DAO change, we will refactor the SQL file directory and file name.
6059
61- - After refactoring the DAO name, change the SQL deployment directory name as well.
60+ - After refactoring the DAO name, change the SQL directory name as well.
6261- After refactoring the DAO method name, we will also change the SQL file name.
6362- After refactoring the DAO package, we will also change the SQL directory.
6463![ RenameDao.gif] ( images/gif/RenameDao.gif )
@@ -83,7 +82,7 @@ This feature works in source JARs as well, but in binary JARs, if the DAO method
8382- The DAO method’s argument parameter definition
8483- The field and method definitions on that parameter’s type
8584- The class definition referenced by @ClassName @
86- - Resolve references for custom functions using the ExpressionFunctions implementation class in which they are defined.
85+ - Custom functions in the configured ExpressionFunctions implementation class
8786- You can also jump using the ** Go To > Declaration Usage** menu.
8887
8988![ Reference.gif] ( images/gif/Reference.gif )
@@ -95,16 +94,18 @@ Some functions of "Doma Tools" can be customized from the settings screen.
9594- Highlight color settings for SQL elements
9695![ setting_highlight.png] ( images/setting_highlight.png )
9796- Customize action shortcut keys
98- - Toggle the SQL formatting feature on or off
99- - Specify the class names that define custom functions.
97+ - Enable/disable automatic indentation when breaking SQL lines
10098
10199** If you want to use custom functions defined in your own ExpressionFunctions implementation class,
102100place a ` doma.compile.config ` file directly under the resources directory and describe the ` doma.expr.functions ` entry.**
103101
102+ [ Doma Setting Options with Configuration File] ( https://doma.readthedocs.io/en/stable/annotation-processing/#setting-options-with-configuration-file )
103+
104104ex) doma.compile.config
105105``` properties
106106doma.expr.functions =example.expression.MyExpressionFunctions
107107```
108108
109109The contents of ` doma.compile.config ` are cached.
110110The cache is updated based on the file's last modified timestamp, so please make sure to save the file after making any changes.
111+ ** Autosave may not update the cache.**
0 commit comments