Variable: outline-use-comment-regexp

outline-use-comment-regexp is a customizable variable defined in outline.el.gz.

Value

nil

Documentation

If non-nil, recognize comment-prefixed headings in outline-minor-mode(var)/outline-minor-mode(fun).

When non-nil, enabling outline-minor-mode(var)/outline-minor-mode(fun) configures outline-regexp and the variable outline-level(var)/outline-level(fun) to recognize outline headings that are prefixed by a comment. The heading pattern is taken from outline-comment-regexp when that variable is set buffer-locally, and otherwise from a default constructed from comment-start and outline-comment-regexp-suffix.

This variable was added, or its default value changed, in Emacs 32.1.

Probably introduced at or before Emacs version 32.1.

Source Code

;; Defined in /usr/src/emacs/lisp/outline.el.gz
;;; Comment-prefixed outline headings

(defcustom outline-use-comment-regexp nil
  "If non-nil, recognize comment-prefixed headings in `outline-minor-mode'.
When non-nil, enabling `outline-minor-mode' configures `outline-regexp'
and the variable `outline-level' to recognize outline headings that are
prefixed by a comment.  The heading pattern is taken from
`outline-comment-regexp' when that variable is set buffer-locally, and
otherwise from a default constructed from `comment-start' and
`outline-comment-regexp-suffix'."
  :type '(choice (const :tag "Don't recognize comment headings" nil)
                 (const :tag "Recognize comment headings" t))
  :group 'outlines
  :version "32.1")