diff options
| author | Stefan Kangas | 2021-09-21 11:14:14 +0200 |
|---|---|---|
| committer | Stefan Kangas | 2021-09-21 11:14:55 +0200 |
| commit | c6eb8df79ef357004b3b1b627c842c5ee2ac6090 (patch) | |
| tree | d3d8fdf51b92a31e1c2cbf89b113957ac545f901 | |
| parent | f23c5c3e445385031d46ee56b89fcda1774a2108 (diff) | |
| download | emacs-c6eb8df79ef357004b3b1b627c842c5ee2ac6090.tar.gz emacs-c6eb8df79ef357004b3b1b627c842c5ee2ac6090.zip | |
; Minor checkdoc fixes in url/*.el
| -rw-r--r-- | lisp/url/url-auth.el | 5 | ||||
| -rw-r--r-- | lisp/url/url-cache.el | 4 | ||||
| -rw-r--r-- | lisp/url/url-cid.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-dired.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-expand.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-gw.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-handlers.el | 1 | ||||
| -rw-r--r-- | lisp/url/url-misc.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-news.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-privacy.el | 2 | ||||
| -rw-r--r-- | lisp/url/url-proxy.el | 2 | ||||
| -rw-r--r-- | 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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-vars) | 26 | (require 'url-vars) |
| @@ -458,8 +460,7 @@ information associated with them.") | |||
| 458 | 460 | ||
| 459 | ;;;###autoload | 461 | ;;;###autoload |
| 460 | (defun url-get-authentication (url realm type prompt &optional args) | 462 | (defun url-get-authentication (url realm type prompt &optional args) |
| 461 | "Return an authorization string suitable for use in the WWW-Authenticate | 463 | "Return authorization string for the WWW-Authenticate header in HTTP/1.0 request. |
| 462 | header in an HTTP/1.0 request. | ||
| 463 | 464 | ||
| 464 | URL is the url you are requesting authorization to. This can be either a | 465 | URL is the url you are requesting authorization to. This can be either a |
| 465 | string representing the URL, or the parsed representation returned by | 466 | 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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-parse) | 26 | (require 'url-parse) |
| @@ -47,7 +49,7 @@ Used by the function `url-cache-expired'." | |||
| 47 | (file-directory-p (file-name-directory file))))) | 49 | (file-directory-p (file-name-directory file))))) |
| 48 | 50 | ||
| 49 | (defun url-cache-prepare (file) | 51 | (defun url-cache-prepare (file) |
| 50 | "Makes it possible to cache data in FILE. | 52 | "Make it possible to cache data in FILE. |
| 51 | Creates any necessary parent directories, deleting any non-directory files | 53 | Creates any necessary parent directories, deleting any non-directory files |
| 52 | that would stop this. Returns nil if parent directories can not be | 54 | that would stop this. Returns nil if parent directories can not be |
| 53 | created. If FILE already exists as a non-directory, it changes | 55 | 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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-vars) | 26 | (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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (autoload 'dired-get-filename "dired") | 26 | (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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-methods) | 26 | (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 @@ | |||
| 21 | ;; You should have received a copy of the GNU General Public License | 21 | ;; You should have received a copy of the GNU General Public License |
| 22 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 22 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 23 | 23 | ||
| 24 | ;;; Commentary: | ||
| 25 | |||
| 24 | ;;; Code: | 26 | ;;; Code: |
| 25 | 27 | ||
| 26 | (require 'url-vars) | 28 | (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 @@ | |||
| 102 | 102 | ||
| 103 | ;;;###autoload | 103 | ;;;###autoload |
| 104 | (define-minor-mode url-handler-mode | 104 | (define-minor-mode url-handler-mode |
| 105 | ;; Can't use "\\[find-file]" below as it produces "[open]": | ||
| 105 | "Handle URLs as if they were file names throughout Emacs. | 106 | "Handle URLs as if they were file names throughout Emacs. |
| 106 | After switching on this minor mode, Emacs file primitives handle | 107 | After switching on this minor mode, Emacs file primitives handle |
| 107 | URLs. For instance: | 108 | 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 @@ | |||
| 20 | ;; You should have received a copy of the GNU General Public License | 20 | ;; You should have received a copy of the GNU General Public License |
| 21 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 21 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 22 | 22 | ||
| 23 | ;;; Commentary: | ||
| 24 | |||
| 23 | ;;; Code: | 25 | ;;; Code: |
| 24 | 26 | ||
| 25 | (require 'url-vars) | 27 | (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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-vars) | 26 | (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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-vars) | 26 | (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 @@ | |||
| 19 | ;; You should have received a copy of the GNU General Public License | 19 | ;; You should have received a copy of the GNU General Public License |
| 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 20 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 21 | 21 | ||
| 22 | ;;; Commentary: | ||
| 23 | |||
| 22 | ;;; Code: | 24 | ;;; Code: |
| 23 | 25 | ||
| 24 | (require 'url-parse) | 26 | (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 @@ | |||
| 20 | ;; You should have received a copy of the GNU General Public License | 20 | ;; You should have received a copy of the GNU General Public License |
| 21 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | 21 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. |
| 22 | 22 | ||
| 23 | ;;; Commentary: | ||
| 24 | |||
| 23 | ;;; Code: | 25 | ;;; Code: |
| 24 | 26 | ||
| 25 | (defgroup url nil | 27 | (defgroup url nil |