Doc fixes for browse-url

* lisp/net/browse-url.el (browse-url-can-use-xdg-open, browse-url-xdg-open):
Doc fixes.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 0e9cf1ebd70069875073eb22ca85d8694ae66acc..891b164a55a5b3782f25dcc84c9fb3ed9edd57f3 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2012-02-09  Glenn Morris  <rgm@gnu.org>
 
+       * net/browse-url.el (browse-url-can-use-xdg-open)
+       (browse-url-xdg-open): Doc fixes.
+
        * electric.el (electric-indent-mode, electric-pair-mode)
        (electric-layout-rules, electric-layout-mode): Doc fixes.
        (electric-pair-pairs, electric-pair-skip-self): Add :version tags.

diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el
index f378277d5f03a455250173860b3dbc5b3aa4fc47..99f3c53f02555c7be7ae8b9d70a7283f3734170c 100644 (file)
--- a/lisp/net/browse-url.el
+++ b/lisp/net/browse-url.el
@@ -944,7 +944,9 @@ used instead of `browse-url-new-window-flag'."
    url args))
 
 (defun browse-url-can-use-xdg-open ()
-  "Check if xdg-open can be used, i.e. we are on Gnome, KDE, Xfce4 or LXDE."
+  "Return non-nil if the \"xdg-open\" program can be used.
+xdg-open is a desktop utility that calls your preferred web browser.
+This requires you to be running either Gnome, KDE, Xfce4 or LXDE."
   (and (getenv "DISPLAY")
        (executable-find "xdg-open")
        ;; xdg-open may call gnome-open and that does not wait for its child
@@ -974,7 +976,10 @@ used instead of `browse-url-new-window-flag'."
 
 
 ;;;###autoload
-(defun browse-url-xdg-open (url &optional new-window)
+(defun browse-url-xdg-open (url &optional ignored)
+  "Pass the specified URL to the \"xdg-open\" command.
+xdg-open is a desktop utility that calls your preferred web browser.
+The optional argument IGNORED is not used."
   (interactive (browse-url-interactive-arg "URL: "))
   (call-process "xdg-open" nil 0 nil url))