Add a new documentation group for overlays
* lisp/emacs-lisp/shortdoc.el (overlay): Add documentation group for buffer overlays(bug#48730).
This commit is contained in:
parent
1230651ffd
commit
e247b4b691
1 changed files with 46 additions and 0 deletions
|
@ -889,6 +889,52 @@ There can be any number of :example/:result elements."
|
|||
(unlock-buffer
|
||||
:no-value (lock-buffer)))
|
||||
|
||||
(define-short-documentation-group overlay
|
||||
"Predicates"
|
||||
(overlayp
|
||||
:no-eval (overlayp some-overlay)
|
||||
:eg-result t)
|
||||
"Creation and Deletion"
|
||||
(make-overlay
|
||||
:args (beg end &optional buffer)
|
||||
:no-eval (make-overlay 1 10)
|
||||
:eg-result-string "#<overlay from 1 to 10 in *foo*>")
|
||||
(delete-overlay
|
||||
:no-eval (delete-overlay foo)
|
||||
:eg-result t)
|
||||
"Searching Overlays"
|
||||
(overlays-at
|
||||
:no-eval (overlays-at 15)
|
||||
:eg-result-string "(#<overlay from 1 to 10 in *foo*>)")
|
||||
(overlays-in
|
||||
:no-eval (overlays-in 1 30)
|
||||
:eg-result-string "(#<overlay from 1 to 10 in *foo*>)")
|
||||
(next-overlay-change
|
||||
:no-eval (next-overlay-change 1)
|
||||
:eg-result 20)
|
||||
(previous-overlay-change
|
||||
:no-eval (previous-overlay-change 30)
|
||||
:eg-result 20)
|
||||
"Overlay Properties"
|
||||
(overlay-start
|
||||
:no-eval (overlay-start foo)
|
||||
:eg-result 1)
|
||||
(overlay-end
|
||||
:no-eval (overlay-end foo)
|
||||
:eg-result 10)
|
||||
(overlay-put
|
||||
:no-eval (overlay-put foo 'happy t)
|
||||
:eg-result t)
|
||||
(overlay-get
|
||||
:no-eval (overlay-get foo 'happy)
|
||||
:eg-result t)
|
||||
(overlay-buffer
|
||||
:no-eval (overlay-buffer foo))
|
||||
"Moving Overlays"
|
||||
(move-overlay
|
||||
:no-eval (move-overlay foo 5 20)
|
||||
:eg-result-string "#<overlay from 5 to 20 in *foo*>"))
|
||||
|
||||
(define-short-documentation-group process
|
||||
(make-process
|
||||
:no-eval (make-process :name "foo" :command '("cat" "/tmp/foo"))
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue