Function: comment-box

comment-box is an interactive and byte-compiled function defined in newcomment.el.gz.

Signature

(comment-box BEG END &optional ARG)

Documentation

Comment out the BEG .. END region, putting it inside a box.

The numeric prefix ARG specifies how many characters to add to begin- and end- comment markers additionally to what variable comment-add(var)/comment-add(fun) already specifies.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/newcomment.el.gz
;;;###autoload
(defun comment-box (beg end &optional arg)
  "Comment out the BEG .. END region, putting it inside a box.
The numeric prefix ARG specifies how many characters to add to begin- and
end- comment markers additionally to what variable `comment-add' already
specifies."
  (interactive "*r\np")
  (comment-normalize-vars)
  (let ((comment-style (if (cadr (assoc comment-style comment-styles))
			   'box-multi 'box)))
    (comment-region beg end (+ comment-add arg))))