From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 10 Jul 2022 00:24:30 +0000 (+0200)
Subject: * lisp/net/browse-url.el: Improve commentary.
X-Git-Tag: emacs-29.0.90~1447^2~1048
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8eb8928337ec4b09229130231ce0ec410c904051;p=emacs.git

* lisp/net/browse-url.el: Improve commentary.
---

diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el
index 8d103e251bf..edb9de9e373 100644
--- a/lisp/net/browse-url.el
+++ b/lisp/net/browse-url.el
@@ -1,4 +1,4 @@
-;;; browse-url.el --- pass a URL to a WWW browser  -*- lexical-binding: t; -*-
+;;; browse-url.el --- pass a URL to a web browser  -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 1995-2022 Free Software Foundation, Inc.
 
@@ -24,14 +24,20 @@
 
 ;;; Commentary:
 
-;; This package provides functions which read a URL (Uniform Resource
-;; Locator) from the minibuffer, defaulting to the URL around point,
-;; and ask a World-Wide Web browser to load it.  It can also load the
-;; URL associated with the current buffer.  Different browsers use
-;; different methods of remote control so there is one function for
-;; each supported browser.  If the chosen browser is not running, it
-;; is started.  Currently there is support for the following browsers,
-;; as well as some other obsolete ones:
+;; This package provides functions which read a URL from the
+;; minibuffer, defaulting to the URL around point, and ask a web
+;; browser to load it.  It can also load the URL at point, or one
+;; associated with the current buffer.  The main functions are:
+
+;;   `browse-url'             Open URL
+;;   `browse-url-at-point'    Open URL at point
+;;   `browse-url-of-buffer'   Use web browser to display buffer
+;;   `browse-url-of-file'     Use web browser to display file
+
+;; Different browsers use different methods of remote control so there
+;; is one function for each supported browser.  If the chosen browser
+;; is not running, it is started.  Currently there is support for the
+;; following browsers, as well as some other obsolete ones:
 
 ;; Function                           Browser     Earliest version
 ;; browse-url-mozilla                 Mozilla     Don't know
@@ -40,7 +46,7 @@
 ;; browse-url-chromium                Chromium    3.0
 ;; browse-url-epiphany                GNOME Web (Epiphany)    Don't know
 ;; browse-url-webpositive             WebPositive 1.2-alpha (Haiku R1/beta3)
-;; browse-url-text-*	              Any text browser     0
+;; browse-url-text-*                  Any text browser     0
 ;; browse-url-generic                 arbitrary
 ;; browse-url-default-windows-browser MS-Windows browser
 ;; browse-url-default-macosx-browser  macOS browser
@@ -49,14 +55,12 @@
 ;; browse-url-elinks                  Elinks      Don't know (tried with 0.12.GIT)
 ;; eww-browse-url                     Emacs Web Wowser
 
-;; Browsers can cache Web pages so it may be necessary to tell them to
+;; Browsers can cache web pages so it may be necessary to tell them to
 ;; reload the current page if it has changed (e.g., if you have edited
 ;; it).  There is currently no perfect automatic solution to this.
 
-;; This package generalizes function html-previewer-process in Marc
-;; Andreessen's html-mode (LCD modes/html-mode.el.Z).  See also the
-;; ffap.el package.  The huge hyperbole package also contains similar
-;; functions.
+;; See also the ffap.el package.  The huge hyperbole package also
+;; contains similar functions.
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; Usage
@@ -82,14 +86,14 @@
 ;; M-x browse-url-of-dired-file RET
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;; Customization (~/.emacs)
+;; Customization (Init File)
 
 ;; To see what variables are available for customization, type
 ;; `M-x set-variable browse-url TAB'.  Better, use
 ;; `M-x customize-group browse-url'.
 
-;; Bind the browse-url commands to keys with the `C-c C-z' prefix
-;; (as used by html-helper-mode):
+;; Bind the browse-url commands to keys with the `C-c C-z' prefix:
+
 ;;	(keymap-global-set "C-c C-z ." 'browse-url-at-point)
 ;;	(keymap-global-set "C-c C-z b" 'browse-url-of-buffer)
 ;;	(keymap-global-set "C-c C-z r" 'browse-url-of-region)