Function: checkdoc-in-example-string-p

checkdoc-in-example-string-p is a byte-compiled function defined in checkdoc.el.gz.

Signature

(checkdoc-in-example-string-p START LIMIT)

Documentation

Return non-nil if the current point is in an "example string".

This string is identified by the characters \" surrounding the text. The text checked is between START and LIMIT.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/checkdoc.el.gz
(defun checkdoc-in-example-string-p (start limit)
  "Return non-nil if the current point is in an \"example string\".
This string is identified by the characters \\\" surrounding the text.
The text checked is between START and LIMIT."
  (save-match-data
    (save-excursion
      (let ((p (point))
	    (c 0))
	(goto-char start)
	(while (and (< (point) p) (re-search-forward "\\\\\"" limit t))
	  (setq c (1+ c)))
	(and (< 0 c) (= (% c 2) 0))))))