emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/treesit-fold e6191cb5ca 210/417: doc


From: ELPA Syncer
Subject: [nongnu] elpa/treesit-fold e6191cb5ca 210/417: doc
Date: Mon, 1 Jul 2024 10:02:26 -0400 (EDT)

branch: elpa/treesit-fold
commit e6191cb5ca7f0acdf283618bce3e61824795ad24
Author: Jen-Chieh <jcs090218@gmail.com>
Commit: Jen-Chieh <jcs090218@gmail.com>

    doc
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index cd8df20617..6b2ebbcd88 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,7 @@ to provide code folding base on the tree-sitter syntax tree.
             - [🔍 How do I create the function for the corresponding 
node?](#🔍-how-do-i-create-the-function-for-the-corresponding-node)
             - [🔍 Register to folding parsers 
alist!](#🔍-register-to-folding-parsers-alist)
         - [❓ How to create a summary 
parser?](#❓-how-to-create-a-summary-parser)
+            - [🔍 Register to summary parsers 
alist!](#🔍-register-to-summary-parsers-alist)
 
 <!-- markdown-toc end -->
 
@@ -274,3 +275,17 @@ Let's see the implementation,
 ```
 
 The above summary parser for Javadoc simply remove `*` from any given point.
+
+#### 🔍 Register to summary parsers alist!
+
+Like folding parsers, you should register your summary parser to the entry 
alist
+with the corresponding `major-mode`.
+
+```elisp
+(defcustom ts-fold-summary-parsers-alist
+  `((actionscript-mode . ts-fold-summary-javadoc)
+    (bat-mode          . ts-fold-summary-batch)
+    (c-mode            . ts-fold-summary-c)
+    (c++-mode          . ts-fold-summary-c)
+    ...
+```



reply via email to

[Prev in Thread] Current Thread [Next in Thread]