summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-05-01 00:10:57 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-05-01 00:10:57 +0200
commit4b7bb8f596550628eaa83b82c0f7eabe59a84964 (patch)
treed23fddf5640314d88c3e0ab7c63507969104f0d4
parent032b05103136e6aa0a9640a3e3fa56fefebf7119 (diff)
Fill some imenu--index-alist doc lines
* lisp/imenu.el (imenu--index-alist): Fill some doc lines (bug#21269).
-rw-r--r--lisp/imenu.el13
1 files changed, 8 insertions, 5 deletions
diff --git a/lisp/imenu.el b/lisp/imenu.el
index 44bae2dd3b..48257b892d 100644
--- a/lisp/imenu.el
+++ b/lisp/imenu.el
@@ -462,12 +462,15 @@ Don't move point."
Simple elements in the alist look like (INDEX-NAME . POSITION).
POSITION is the buffer position of the item; to go to the item
is simply to move point to that position.
-POSITION is passed to `imenu-default-goto-function', so it can be a non-number
-if that variable has been changed (e.g. Semantic uses overlays for POSITIONs).
-Special elements look like (INDEX-NAME POSITION FUNCTION ARGUMENTS...).
-To \"go to\" a special element means applying FUNCTION
-to INDEX-NAME, POSITION, and the ARGUMENTS.
+POSITION is passed to `imenu-default-goto-function', so it can be
+a non-number if that variable has been changed (e.g. Semantic
+uses overlays for POSITIONs).
+
+Special elements look like
+\(INDEX-NAME POSITION FUNCTION ARGUMENTS...).
+To \"go to\" a special element means applying FUNCTION to
+INDEX-NAME, POSITION, and the ARGUMENTS.
A nested sub-alist element looks like (INDEX-NAME . SUB-ALIST).
The function `imenu--subalist-p' tests an element and returns t