Skip to content

Commit 63c7d62

Browse files
authored
Merge pull request #116 from domaframework/doc/add-reference-resolve
Update README to include reference resolution feature details
2 parents 42ff43d + 4681ae2 commit 63c7d62

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,23 @@ This feature is in preview. You cannot customize the indentation or keywords to
6464
You can reformat entire directories and files with "Code > Reformat Code".
6565

6666
If you want to enable the plugin's formatting function, check "Enable SQL Format" in "Settings > Other Settings > Doma Tools". (The default is OFF.)
67+
6768
## Settings
6869
Some functions of "Doma Tools" can be customized from the settings screen.
6970

7071
- Enabling/disabling inspections and customizing error levels
7172
- Highlight color settings for SQL elements
7273
![setting_highlight.png](images/setting_highlight.png)
7374
- Customize action shortcut keys
75+
76+
## Reference resolution
77+
Ctrl+Click on a bind variable in an SQL file to jump to its source symbol:
78+
79+
This feature works in source JARs as well, but in binary JARs, if the DAO method’s argument parameter names have been changed, the references cannot be resolved and the feature will not function.
80+
81+
- The DAO method’s argument parameter definition
82+
- The field and method definitions on that parameter’s type
83+
- The class definition referenced by @ClassName@
84+
- You can also jump using the **Go To > Declaration Usage** menu.
85+
86+
![reference.png](images/reference.png)

images/reference.png

22 KB
Loading

0 commit comments

Comments
 (0)