]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/net/imap.el: Use proper outline headings
authorJonas Bernoulli <jonas@bernoul.li>
Wed, 17 Jun 2020 01:00:12 +0000 (03:00 +0200)
committerJonas Bernoulli <jonas@bernoul.li>
Thu, 13 Aug 2020 09:34:49 +0000 (11:34 +0200)
This library already used section headings but it used just two
instead of three semicolons, making them indistinguishable from
plain comments.  One heading is new.

lisp/net/imap.el

index a492dc8c7986fc7c51f36c830edf44d60021bd4e..22b59084004ba276cc81eb0ff432f853d13056cc 100644 (file)
 ;;
 
 ;;; Code:
+;;; Dependencies
 
 (eval-when-compile (require 'cl-lib))
 (require 'utf7)
 (declare-function digest-md5-digest-uri "ext:digest-md5")
 (declare-function digest-md5-challenge "ext:digest-md5")
 
-;; User variables.
+;;; User variables
 
 (defgroup imap nil
   "Low-level IMAP issues."
@@ -257,7 +258,7 @@ Shorter values mean quicker response, but is more CPU intensive."
   :group 'imap
   :type 'boolean)
 
-;; Various variables.
+;;; Various variables
 
 (defvar imap-fetch-data-hook nil
   "Hooks called after receiving each FETCH response.")
@@ -316,7 +317,9 @@ the value of this variable will be bound to a certain value to which
 an application program that uses this module specifies on a per-server
 basis.")
 
-;; Internal constants.  Change these and die.
+;;; Internal constants
+
+;; Change these and die.
 
 (defconst imap-default-port 143)
 (defconst imap-default-ssl-port 993)
@@ -348,7 +351,7 @@ basis.")
 (defconst imap-log-buffer "*imap-log*")
 (defconst imap-debug-buffer "*imap-debug*")
 
-;; Internal variables.
+;;; Internal variables
 
 (defvar imap-stream nil)
 (defvar imap-auth nil)
@@ -437,7 +440,7 @@ This variable is set to t automatically per server if the
 canonical form fails.")
 
 \f
-;; Utility functions:
+;;; Utility functions
 
 (defun imap-remassoc (key alist)
   "Delete by side effect any elements of ALIST whose car is `equal' to KEY.
@@ -489,7 +492,8 @@ sure of changing the value of `foo'."
     (nth 3 (car imap-failed-tags))))
 
 \f
-;; Server functions; stream stuff:
+;;; Server functions
+;;;; Stream functions
 
 (defun imap-log (string-or-buffer)
   (when imap-log
@@ -747,7 +751,7 @@ sure of changing the value of `foo'."
     (message "imap: Connecting with STARTTLS...%s" (if done "done" "failed"))
     done))
 
-;; Server functions; authenticator stuff:
+;;;; Authenticator functions
 
 (defun imap-interactive-login (buffer loginfunc)
   "Login to server in BUFFER.
@@ -871,7 +875,7 @@ t if it successfully authenticates, nil otherwise."
                (concat "LOGIN anonymous \"" (concat (user-login-name) "@"
                                                     (system-name)) "\"")))))
 
-;;; Compiler directives.
+;;; Compiler directives
 
 (defvar imap-sasl-client)
 (defvar imap-sasl-step)
@@ -969,7 +973,7 @@ t if it successfully authenticates, nil otherwise."
         (imap-send-command-1 "")
         (imap-ok-p (imap-wait-for-tag tag)))))))
 
-;; Server functions:
+;;; Server functions
 
 (defun imap-open-1 (buffer)
   (with-current-buffer buffer
@@ -1228,7 +1232,7 @@ If BUFFER is nil, the current buffer is assumed."
     (imap-send-command-wait "LOGOUT" buffer)))
 
 \f
-;; Mailbox functions:
+;;; Mailbox functions
 
 (defun imap-mailbox-put (propname value &optional mailbox buffer)
   (with-current-buffer (or buffer (current-buffer))
@@ -1520,7 +1524,7 @@ or `unseen'.  The IMAP command tag is returned."
                                     identifier))))))
 
 \f
-;; Message functions:
+;;; Message functions
 
 (defun imap-current-message (&optional buffer)
   (with-current-buffer (or buffer (current-buffer))
@@ -1832,7 +1836,7 @@ on failure."
               (if (aref from 0) ">"))))
 
 \f
-;; Internal functions.
+;;; Internal functions
 
 (defun imap-add-callback (tag func)
   (setq imap-callbacks (append (list (cons tag func)) imap-callbacks)))
@@ -1969,7 +1973,7 @@ Return nil if no complete line has arrived."
              (delete-region (point-min) (point-max)))))))))
 
 \f
-;; Imap parser.
+;;; Imap parser
 
 (defsubst imap-forward ()
   (or (eobp) (forward-char)))
@@ -2850,6 +2854,8 @@ Return nil if no complete line has arrived."
        (imap-forward)
        (nreverse body)))))
 
+;;; Debug
+
 (when imap-debug                       ; (untrace-all)
   (require 'trace)
   (buffer-disable-undo (get-buffer-create imap-debug-buffer))