Function: semantic-elisp-form-to-doc-string

semantic-elisp-form-to-doc-string is a byte-compiled function defined in el.el.gz.

Signature

(semantic-elisp-form-to-doc-string FORM)

Documentation

After reading a form FORM, convert it to a doc string.

For Emacs Lisp, sometimes that string is non-existent. Sometimes it is a form which is evaluated at compile time, permitting compound strings.

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/semantic/bovine/el.el.gz
(defun semantic-elisp-form-to-doc-string (form)
  "After reading a form FORM, convert it to a doc string.
For Emacs Lisp, sometimes that string is non-existent.
Sometimes it is a form which is evaluated at compile time, permitting
compound strings."
  (cond ((stringp form) form)
	((and (listp form) (eq (car form) 'concat)
	      (stringp (nth 1 form)))
	 (nth 1 form))
	(t nil)))