branch: externals/matlab-mode
commit e6bd1df9b8210532a28b5e17675017968721edf8
Author: John Ciolfi <john.ciolfi...@gmail.com>
Commit: John Ciolfi <john.ciolfi...@gmail.com>
doc/matlab-language-server-lsp-mode.org - add find references
---
.../lsp-mode-annotated-pictures.pptx | Bin 159572 -> 230890 bytes
.../lspExample.m | 2 -
.../lspExample2.m | 7 +++
.../matlab-and-lsp-mode-find-references.png | Bin 0 -> 193622 bytes
doc/matlab-language-server-lsp-mode.org | 49 ++++++++++++---------
5 files changed, 35 insertions(+), 23 deletions(-)
diff --git
a/doc/matlab-language-server-lsp-mode-files/lsp-mode-annotated-pictures.pptx
b/doc/matlab-language-server-lsp-mode-files/lsp-mode-annotated-pictures.pptx
index 4826c0fd7b..ed60654935 100644
Binary files
a/doc/matlab-language-server-lsp-mode-files/lsp-mode-annotated-pictures.pptx
and
b/doc/matlab-language-server-lsp-mode-files/lsp-mode-annotated-pictures.pptx
differ
diff --git a/doc/matlab-language-server-lsp-mode-files/lspExample.m
b/doc/matlab-language-server-lsp-mode-files/lspExample.m
index 89489b1867..4856c40f25 100644
--- a/doc/matlab-language-server-lsp-mode-files/lspExample.m
+++ b/doc/matlab-language-server-lsp-mode-files/lspExample.m
@@ -1,7 +1,5 @@
function out = lspExample(a, b)
% LSPEXAMPLE - Language Server Protocol example
-%
-%
f1 = func1(a);
f2 = func2(b);
diff --git a/doc/matlab-language-server-lsp-mode-files/lspExample2.m
b/doc/matlab-language-server-lsp-mode-files/lspExample2.m
new file mode 100644
index 0000000000..90804c4fb6
--- /dev/null
+++ b/doc/matlab-language-server-lsp-mode-files/lspExample2.m
@@ -0,0 +1,7 @@
+function out = lspExample2(a, b)
+% LSPEXAMPLE2 - Language Server Protocol example2
+
+ x = func3(a);
+ y = func3(b);
+ out = x + y;
+end
diff --git
a/doc/matlab-language-server-lsp-mode-files/matlab-and-lsp-mode-find-references.png
b/doc/matlab-language-server-lsp-mode-files/matlab-and-lsp-mode-find-references.png
new file mode 100644
index 0000000000..b77c193369
Binary files /dev/null and
b/doc/matlab-language-server-lsp-mode-files/matlab-and-lsp-mode-find-references.png
differ
diff --git a/doc/matlab-language-server-lsp-mode.org
b/doc/matlab-language-server-lsp-mode.org
index d8d57f46d2..b395ac427e 100644
--- a/doc/matlab-language-server-lsp-mode.org
+++ b/doc/matlab-language-server-lsp-mode.org
@@ -26,7 +26,33 @@
#+options: toc:nil
The [[https://github.com/mathworks/MATLAB-language-server][MATLAB Language
Server]], matlabls, is used for code navigation, code completion,
-go to definition, find references, and more. To use matlabls,
+go to definition, find references, and more. To use matlabls, see
[[Installation][installation]] below.
+It also works with Emacs on Windows as show below.
+
+* Code Navigation - Jump to Definition and Back
+
+Below we are in =lspExample.m= and then type =M-.= to jump to the definition
in =func3.m=. We then
+type =M-,= to jump back.
+
+[[file:matlab-language-server-lsp-mode-files/matlab-lsp-mode-jump-to-definition.gif]]
+
+* Code Navigation - Find References
+
+[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-mode-find-references.png]]
+
+* Viewing Issues Without the lsp-ui Package
+
+[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-mode-flycheck.png]]
+
+* Viewing Issues With the lsp-ui Package
+
+[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-ui-sideline-mode.png]]
+
+* Navigation with lsp-ui-imenu
+
+[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-ui-imenu.png]]
+
+* Installation
1. Install lsp-mode from MELPA
@@ -99,7 +125,7 @@ go to definition, find references, and more. To use matlabls,
: M-? Find references to the identifier at point (xref-find-references)
: M-, Go back to the previous position in xref history (xref-go-back)
-* Windows Emacs with LSP
+** Windows Emacs with LSP
The examples below were created on Windows 11 using Emacs 30.1. The setup I
used (May-29-2025):
@@ -111,22 +137,3 @@ The examples below were created on Windows 11 using Emacs
30.1. The setup I use
4. Install the Emacs packages listed above.
5. Install the MATLAB Lanugage Server as shown above.
-* Code Navigation - Jump to Definition and Back
-
-Below we are in =lspExample.m= and then type =M-.= to jump to the definition
in =func3.m=. We then
-type =M-,= to jump back.
-
-[[file:matlab-language-server-lsp-mode-files/matlab-lsp-mode-jump-to-definition.gif]]
-
-
-* Viewing Issues Without the lsp-ui Package
-
-[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-mode-flycheck.png]]
-
-* Viewing Issues With the lsp-ui Package
-
-[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-ui-sideline-mode.png]]
-
-* Navigation with lsp-ui-imenu
-
-[[file:matlab-language-server-lsp-mode-files/matlab-and-lsp-ui-imenu.png]]
