Variable: outline-comment-regexp

outline-comment-regexp is a buffer-local variable defined in outline.el.gz.

Documentation

If non-nil, regexp matching comment-prefixed outline headings.

This has an effect only when outline-use-comment-regexp is non-nil. In that case, enabling outline-minor-mode(var)/outline-minor-mode(fun) derives outline-regexp and the variable outline-level(var)/outline-level(fun) from it.

Group 1 of the regexp must match the heading-level characters; the heading level is the length of that group's match. For example, the value

  ";;; \\([*]+\\)"

recognizes the headings ";;; *", ";;; **", and so on, using the number of stars as the level.

When this variable is nil, a default is constructed from comment-start and outline-comment-regexp-suffix. Major modes can set this variable to provide a mode-specific heading syntax.

Probably introduced at or before Emacs version 32.1.

Source Code

;; Defined in /usr/src/emacs/lisp/outline.el.gz
(defvar-local outline-comment-regexp nil
  "If non-nil, regexp matching comment-prefixed outline headings.
This has an effect only when `outline-use-comment-regexp' is non-nil.
In that case, enabling `outline-minor-mode' derives `outline-regexp'
and the variable `outline-level' from it.

Group 1 of the regexp must match the heading-level characters; the
heading level is the length of that group's match.  For example, the
value

  \";;; \\([*]+\\)\"

recognizes the headings \";;; *\", \";;; **\", and so on, using the number
of stars as the level.

When this variable is nil, a default is constructed from `comment-start'
and `outline-comment-regexp-suffix'.  Major modes can set this variable
to provide a mode-specific heading syntax.")