Function: allout-lead-with-comment-string

allout-lead-with-comment-string is an interactive and byte-compiled function defined in allout.el.gz.

Signature

(allout-lead-with-comment-string &optional HEADER-LEAD)

Documentation

Set the topic-header leading string to specified string.

Useful for encapsulating outline structure in programming language comments. Returns the leading string.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/allout.el.gz
;;;_   X allout-lead-with-comment-string (header-lead)
(defun allout-lead-with-comment-string (&optional header-lead)
  "Set the topic-header leading string to specified string.

Useful for encapsulating outline structure in programming
language comments.  Returns the leading string."

  (interactive "P")
  (if (not (stringp header-lead))
      (setq header-lead (read-string
                         "String prefix for topic headers: ")))
  (setq allout-reindent-bodies nil)
  (allout-reset-header-lead header-lead)
  header-lead)