[nongnu] elpa/htmlize ef8b865 055/134: Add some docs.

[ELPA Syncer]

branch: elpa/htmlize
commit ef8b865f3ede66b1377e57bcf0fe76cb088b9c6d
Author: Hrvoje Niksic <hniksic@gmail.com>
Commit: Hrvoje Niksic <hniksic@gmail.com>

    Add some docs.
---
 htmlize.el | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/htmlize.el b/htmlize.el
index ec97b04..e7a87a6 100644
--- a/htmlize.el
+++ b/htmlize.el
@@ -422,6 +422,8 @@ next-single-char-property-change")))
     (htmlize-generate-image (cdr display))))
 
 (defun htmlize-string-to-html (string)
+  ;; Convert the string to HTML, including images attached as
+  ;; `display' property.
   (let ((pos 0) (end (length string))
         display output next-change)
     (while (< pos end)
@@ -476,6 +478,11 @@ next-single-char-property-change")))
             (t nil)))))
 
 (defun htmlize-get-text-with-display (beg end)
+  ;; Like buffer-substring-no-properties, except it copies the
+  ;; `display' property from the buffer, if found.  We cannot rely on
+  ;; Emacs to copy the property because it can come from either text
+  ;; properties or overlays, and the latter can't be attached to
+  ;; strings.
   (let ((pos beg)
         (text (buffer-substring-no-properties beg end))
         display next-change)