summaryrefslogtreecommitdiff
path: root/lisp/image-mode.el
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2022-08-18 17:36:54 +0200
committerStefan Kangas <stefankangas@gmail.com>2022-08-18 17:43:30 +0200
commit254ba1d3e5c4499ef56d0452803a7c1011d7712f (patch)
treeac2d20087e6168397f9e3d9e3b20a6f8c396967b /lisp/image-mode.el
parentac43ac1af9dac42d30fbee044defee6e2641ebfc (diff)
downloademacs-254ba1d3e5c4499ef56d0452803a7c1011d7712f.tar.gz
* lisp/image-mode.el: Improve commentary.
Diffstat (limited to 'lisp/image-mode.el')
-rw-r--r--lisp/image-mode.el12
1 files changed, 8 insertions, 4 deletions
diff --git a/lisp/image-mode.el b/lisp/image-mode.el
index 1eb7cd58c3d..41a87a1a3f2 100644
--- a/lisp/image-mode.el
+++ b/lisp/image-mode.el
@@ -23,10 +23,14 @@
;;; Commentary:
-;; Defines a major mode for visiting image files
-;; that allows conversion between viewing the text of the file,
-;; hex of the file and viewing the file as an image. Viewing the image
-;; works by putting a `display' text-property on the
+;; Defines `image-mode', a major mode for visiting image files. Displaying
+;; images only works only if Emacs was built with support for
+;; displaying such images. See Info node `(emacs) Image Mode' for
+;; more information.
+;;
+;; There is support for switching between viewing the text of the
+;; file, the hex of the file and viewing the file as an image.
+;; Viewing the image works by putting a `display' text-property on the
;; image data, with the image-data still present underneath; if the
;; resulting buffer file is saved to another name it will correctly save
;; the image data to the new file.