master c6eb8df: ; Minor checkdoc fixes in url/*.el

[Stefan Kangas]

branch: master
commit c6eb8df79ef357004b3b1b627c842c5ee2ac6090
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>

    ; 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 06cfacc..2d9a775 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 <https://www.gnu.org/licenses/>.
 
+;;; 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 830e6ba..f869d2e 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 <https://www.gnu.org/licenses/>.
 
+;;; 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 0ca2d8a..3095f7b 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-vars)
diff --git a/lisp/url/url-dired.el b/lisp/url/url-dired.el
index 398113d..feb7c50 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (autoload 'dired-get-filename "dired")
diff --git a/lisp/url/url-expand.el b/lisp/url/url-expand.el
index 05088e3..4e737e9 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-methods)
diff --git a/lisp/url/url-gw.el b/lisp/url/url-gw.el
index d2bf843..caffa6f 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-vars)
diff --git a/lisp/url/url-handlers.el b/lisp/url/url-handlers.el
index ed0402a..650c610 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 fe2393b..c741b6c 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-vars)
diff --git a/lisp/url/url-news.el b/lisp/url/url-news.el
index 4fe909c..c921686 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-vars)
diff --git a/lisp/url/url-privacy.el b/lisp/url/url-privacy.el
index d926775..58ae6ef 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-vars)
diff --git a/lisp/url/url-proxy.el b/lisp/url/url-proxy.el
index c89c1b6..0ffe516 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (require 'url-parse)
diff --git a/lisp/url/url-vars.el b/lisp/url/url-vars.el
index f0d70ff..d916a71 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 <https://www.gnu.org/licenses/>.
 
+;;; Commentary:
+
 ;;; Code:
 
 (defgroup url nil