From c6eb8df79ef357004b3b1b627c842c5ee2ac6090 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Tue, 21 Sep 2021 11:14:14 +0200 Subject: [PATCH] ; Minor checkdoc fixes in url/*.el --- lisp/url/url-auth.el | 5 +++-- lisp/url/url-cache.el | 4 +++- lisp/url/url-cid.el | 2 ++ lisp/url/url-dired.el | 2 ++ lisp/url/url-expand.el | 2 ++ lisp/url/url-gw.el | 2 ++ lisp/url/url-handlers.el | 1 + lisp/url/url-misc.el | 2 ++ lisp/url/url-news.el | 2 ++ lisp/url/url-privacy.el | 2 ++ lisp/url/url-proxy.el | 2 ++ lisp/url/url-vars.el | 2 ++ 12 files changed, 25 insertions(+), 3 deletions(-) diff --git a/lisp/url/url-auth.el b/lisp/url/url-auth.el index 06cfacc99d6..2d9a7758f13 100644 --- a/lisp/url/url-auth.el +++ b/lisp/url/url-auth.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-vars) @@ -458,8 +460,7 @@ information associated with them.") ;;;###autoload (defun url-get-authentication (url realm type prompt &optional args) - "Return an authorization string suitable for use in the WWW-Authenticate -header in an HTTP/1.0 request. + "Return authorization string for the WWW-Authenticate header in HTTP/1.0 request. URL is the url you are requesting authorization to. This can be either a string representing the URL, or the parsed representation returned by diff --git a/lisp/url/url-cache.el b/lisp/url/url-cache.el index 830e6ba9dcc..f869d2e2cf1 100644 --- a/lisp/url/url-cache.el +++ b/lisp/url/url-cache.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-parse) @@ -47,7 +49,7 @@ Used by the function `url-cache-expired'." (file-directory-p (file-name-directory file))))) (defun url-cache-prepare (file) - "Makes it possible to cache data in FILE. + "Make it possible to cache data in FILE. Creates any necessary parent directories, deleting any non-directory files that would stop this. Returns nil if parent directories can not be created. If FILE already exists as a non-directory, it changes diff --git a/lisp/url/url-cid.el b/lisp/url/url-cid.el index 0ca2d8a0737..3095f7bd2c1 100644 --- a/lisp/url/url-cid.el +++ b/lisp/url/url-cid.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-vars) diff --git a/lisp/url/url-dired.el b/lisp/url/url-dired.el index 398113db139..feb7c50ce53 100644 --- a/lisp/url/url-dired.el +++ b/lisp/url/url-dired.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (autoload 'dired-get-filename "dired") diff --git a/lisp/url/url-expand.el b/lisp/url/url-expand.el index 05088e3cac8..4e737e965dd 100644 --- a/lisp/url/url-expand.el +++ b/lisp/url/url-expand.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-methods) diff --git a/lisp/url/url-gw.el b/lisp/url/url-gw.el index d2bf843fc36..caffa6fb7bd 100644 --- a/lisp/url/url-gw.el +++ b/lisp/url/url-gw.el @@ -21,6 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-vars) diff --git a/lisp/url/url-handlers.el b/lisp/url/url-handlers.el index ed0402a5137..650c610e04c 100644 --- a/lisp/url/url-handlers.el +++ b/lisp/url/url-handlers.el @@ -102,6 +102,7 @@ ;;;###autoload (define-minor-mode url-handler-mode + ;; Can't use "\\[find-file]" below as it produces "[open]": "Handle URLs as if they were file names throughout Emacs. After switching on this minor mode, Emacs file primitives handle URLs. For instance: diff --git a/lisp/url/url-misc.el b/lisp/url/url-misc.el index fe2393beb64..c741b6c85a3 100644 --- a/lisp/url/url-misc.el +++ b/lisp/url/url-misc.el @@ -20,6 +20,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-vars) diff --git a/lisp/url/url-news.el b/lisp/url/url-news.el index 4fe909cadbc..c9216862b0f 100644 --- a/lisp/url/url-news.el +++ b/lisp/url/url-news.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-vars) diff --git a/lisp/url/url-privacy.el b/lisp/url/url-privacy.el index d926775c48d..58ae6efbfc1 100644 --- a/lisp/url/url-privacy.el +++ b/lisp/url/url-privacy.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-vars) diff --git a/lisp/url/url-proxy.el b/lisp/url/url-proxy.el index c89c1b6bc3e..0ffe51616db 100644 --- a/lisp/url/url-proxy.el +++ b/lisp/url/url-proxy.el @@ -19,6 +19,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (require 'url-parse) diff --git a/lisp/url/url-vars.el b/lisp/url/url-vars.el index f0d70ff6e75..d916a71e41b 100644 --- a/lisp/url/url-vars.el +++ b/lisp/url/url-vars.el @@ -20,6 +20,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;;; Code: (defgroup url nil