]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/image-mode.el: Improve commentary.
authorStefan Kangas <stefankangas@gmail.com>
Thu, 18 Aug 2022 15:36:54 +0000 (17:36 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Thu, 18 Aug 2022 15:43:30 +0000 (17:43 +0200)
lisp/image-mode.el

index 1eb7cd58c3d3adebf632a5a697b96f662e14eaa4..41a87a1a3f268bd9ffb406149ae03420e748a574 100644 (file)
 
 ;;; 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.