aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBjörn Bidar2025-01-31 02:53:34 +0200
committerStefan Kangas2025-02-13 10:30:31 +0100
commitc5bfaf1ae3ebc258b9d1597ea93df57a55272dcc (patch)
treef74e030f5a2fc98350a7d2394b8c51b43da489f2
parent07d1fdb1ea259e1832e0b0c03b2d2fc9a052037f (diff)
downloademacs-c5bfaf1ae3ebc258b9d1597ea93df57a55272dcc.tar.gz
emacs-c5bfaf1ae3ebc258b9d1597ea93df57a55272dcc.zip
Add missing documentation strings in sieve.el
* lisp/net/sieve.el (sieve-activate, sieve-deactivate-all) (sieve-remove, sieve-edit-script, sieve-refersh-scriptlist) (sieve-upload, sieve-upload-and-burry, sieve-upload-and-kill): Add documentation strings. (Bug#75956)
-rw-r--r--lisp/net/sieve.el10
1 files changed, 10 insertions, 0 deletions
diff --git a/lisp/net/sieve.el b/lisp/net/sieve.el
index 1315cc23fa2..6bb17000919 100644
--- a/lisp/net/sieve.el
+++ b/lisp/net/sieve.el
@@ -161,6 +161,7 @@ require \"fileinto\";
161 (bury-buffer)) 161 (bury-buffer))
162 162
163(defun sieve-activate (&optional _pos) 163(defun sieve-activate (&optional _pos)
164 "Activate script at point."
164 (interactive) 165 (interactive)
165 (let ((name (sieve-script-at-point)) err) 166 (let ((name (sieve-script-at-point)) err)
166 (when (or (null name) (string-equal name sieve-new-script)) 167 (when (or (null name) (string-equal name sieve-new-script))
@@ -173,6 +174,7 @@ require \"fileinto\";
173 (message "Activating script %s...failed: %s" name (nth 2 err))))) 174 (message "Activating script %s...failed: %s" name (nth 2 err)))))
174 175
175(defun sieve-deactivate-all (&optional _pos) 176(defun sieve-deactivate-all (&optional _pos)
177 "Deactivate all currently active scripts."
176 (interactive) 178 (interactive)
177 (message "Deactivating scripts...") 179 (message "Deactivating scripts...")
178 (let (;; (name (sieve-script-at-point)) 180 (let (;; (name (sieve-script-at-point))
@@ -185,6 +187,7 @@ require \"fileinto\";
185(defalias 'sieve-deactivate #'sieve-deactivate-all) 187(defalias 'sieve-deactivate #'sieve-deactivate-all)
186 188
187(defun sieve-remove (&optional _pos) 189(defun sieve-remove (&optional _pos)
190 "Remove script at point."
188 (interactive) 191 (interactive)
189 (let ((name (sieve-script-at-point)) err) 192 (let ((name (sieve-script-at-point)) err)
190 (when (or (null name) (string-equal name sieve-new-script)) 193 (when (or (null name) (string-equal name sieve-new-script))
@@ -197,6 +200,7 @@ require \"fileinto\";
197 (message "Removing sieve script %s...done" name))) 200 (message "Removing sieve script %s...done" name)))
198 201
199(defun sieve-edit-script (&optional _pos) 202(defun sieve-edit-script (&optional _pos)
203 "Edit script at point."
200 (interactive) 204 (interactive)
201 (let ((name (sieve-script-at-point))) 205 (let ((name (sieve-script-at-point)))
202 (unless name 206 (unless name
@@ -310,6 +314,7 @@ Used to bracket operations which move point in the sieve-buffer."
310 (sieve-manage-authenticate))) 314 (sieve-manage-authenticate)))
311 315
312(defun sieve-refresh-scriptlist () 316(defun sieve-refresh-scriptlist ()
317 "Refresh list of scripts found the currently opened server."
313 (interactive) 318 (interactive)
314 (with-current-buffer sieve-buffer 319 (with-current-buffer sieve-buffer
315 (setq buffer-read-only nil) 320 (setq buffer-read-only nil)
@@ -357,6 +362,9 @@ specified, fall back to `sieve-manage-default-port'."
357 362
358;;;###autoload 363;;;###autoload
359(defun sieve-upload (&optional name) 364(defun sieve-upload (&optional name)
365 "Upload script NAME to currently opened server.
366If NAME is nil, detect it from script buffer name.
367If no open sieve buffer exists, call `sieve-manage' first."
360 (interactive) 368 (interactive)
361 (when (or (get-buffer sieve-buffer) 369 (when (or (get-buffer sieve-buffer)
362 (save-current-buffer (call-interactively 'sieve-manage))) 370 (save-current-buffer (call-interactively 'sieve-manage)))
@@ -375,12 +383,14 @@ specified, fall back to `sieve-manage-default-port'."
375 383
376;;;###autoload 384;;;###autoload
377(defun sieve-upload-and-bury (&optional name) 385(defun sieve-upload-and-bury (&optional name)
386 "Upload script NAME and bury the current buffer."
378 (interactive) 387 (interactive)
379 (sieve-upload name) 388 (sieve-upload name)
380 (bury-buffer)) 389 (bury-buffer))
381 390
382;;;###autoload 391;;;###autoload
383(defun sieve-upload-and-kill (&optional name) 392(defun sieve-upload-and-kill (&optional name)
393 "Upload script NAME and kill the current buffer."
384 (interactive) 394 (interactive)
385 (sieve-upload name) 395 (sieve-upload name)
386 (kill-buffer)) 396 (kill-buffer))