Add missing function docstrings
This commit is contained in:
parent
a68ac22b64
commit
a0b669e25b
13
pip-frame.el
13
pip-frame.el
@ -84,7 +84,7 @@ custom option but it can be overriden here."
|
|||||||
frame))
|
frame))
|
||||||
|
|
||||||
(defun pip-frame-delete-frame ()
|
(defun pip-frame-delete-frame ()
|
||||||
""
|
"Delete the PIP frame."
|
||||||
(interactive)
|
(interactive)
|
||||||
(delete-frame (pip-frame--get-frame)))
|
(delete-frame (pip-frame--get-frame)))
|
||||||
|
|
||||||
@ -108,7 +108,9 @@ custom option but it can be overriden here."
|
|||||||
|
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(defun pip-frame-add-buffer ()
|
(defun pip-frame-add-buffer ()
|
||||||
""
|
"Add the current buffer to the PIP frame.
|
||||||
|
If there is no PIP frame then create one.
|
||||||
|
A buffer can be added and displayed multiple times in the frame."
|
||||||
(interactive)
|
(interactive)
|
||||||
(let ((frame (or (pip-frame--get-frame t))))
|
(let ((frame (or (pip-frame--get-frame t))))
|
||||||
(if frame
|
(if frame
|
||||||
@ -116,7 +118,8 @@ custom option but it can be overriden here."
|
|||||||
(pip-frame--make-frame))))
|
(pip-frame--make-frame))))
|
||||||
|
|
||||||
(defun pip-frame-remove-buffer (buffer-name)
|
(defun pip-frame-remove-buffer (buffer-name)
|
||||||
""
|
"Remove buffer named BUFFER-NAME from the PIP frame.
|
||||||
|
If it is the last buffer in the PIP frame, delete the frame."
|
||||||
(interactive (list (completing-read "Remove PIP buffer: "
|
(interactive (list (completing-read "Remove PIP buffer: "
|
||||||
(mapcar #'buffer-name (pip-frame--buffers))
|
(mapcar #'buffer-name (pip-frame--buffers))
|
||||||
nil t)))
|
nil t)))
|
||||||
@ -164,7 +167,9 @@ custom option but it can be overriden here."
|
|||||||
map))
|
map))
|
||||||
|
|
||||||
(defun pip-frame-move ()
|
(defun pip-frame-move ()
|
||||||
""
|
"Move PIP frame interactively.
|
||||||
|
Use arrow keys to move the frame around.
|
||||||
|
Any other key stops this command and executes its own command."
|
||||||
(interactive)
|
(interactive)
|
||||||
(message "Use arrow keys to move the frame, any other key to quit")
|
(message "Use arrow keys to move the frame, any other key to quit")
|
||||||
(set-transient-map pip-frame-move-map t))
|
(set-transient-map pip-frame-move-map t))
|
||||||
|
Loading…
Reference in New Issue
Block a user