Add a couple of shr doc strings

* shr.el (shr-insert-document): Add doc string.
(shr-visit-file): Ditto.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 7004ae6..7283576 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2012-02-07  Lars Ingebrigtsen  <larsi@gnus.org>
+
+       * shr.el (shr-insert-document): Add doc string.
+       (shr-visit-file): Ditto.
+
 2012-02-06  Lars Ingebrigtsen  <larsi@gnus.org>
 
        * gnus-sum.el (gnus-summary-exit-no-update): Really deaden the summary

diff --git a/lisp/shr.el b/lisp/shr.el
index acce766..26755f8 100644 (file)
--- a/lisp/shr.el
+++ b/lisp/shr.el
@@ -128,6 +128,7 @@ cid: URL as the argument.")
 ;; Public functions and commands.
 
 (defun shr-visit-file (file)
+  "Parse FILE as an HTML document, and render it in a new buffer."
   (interactive "fHTML file name: ")
   (pop-to-buffer "*html*")
   (erase-buffer)
@@ -139,6 +140,9 @@ cid: URL as the argument.")
 
 ;;;###autoload
 (defun shr-insert-document (dom)
+  "Render the parsed document DOM into the current buffer.
+DOM should be a parse tree as generated by
+`libxml-parse-html-region' or similar."
   (setq shr-content-cache nil)
   (let ((shr-state nil)
        (shr-start nil)