Function: srecode-texi-texify-docstring-emacs-lisp-mode

srecode-texi-texify-docstring-emacs-lisp-mode is a byte-compiled function defined in texi.el.gz.

Signature

(srecode-texi-texify-docstring-emacs-lisp-mode STRING)

Documentation

Take STRING, (a normal doc string), and convert it into a texinfo string.

For instances where CLASS is the class being referenced, do not Xref that class.

 function => @dfn{function}
 variable => @code{variable}
 class => @code{class} @xref{class}
 unknown => @code{unknown}
 "text" => ``text''
 'quoteme => @code{quoteme}
 non-nil => non-@code{nil}
 t => @code{t}
 :tag => @code{:tag}
 [ stuff ] => @code{[ stuff ]}
 Key => @kbd{Key} (key is C\-h, M\-h, SPC, RET, TAB and the like)
 ... => @dots{}
Override srecode-texi-texify-docstring in emacs-lisp-mode buffers.

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/srecode/texi.el.gz
;;; Texinfo mangling.

(define-overloadable-function srecode-texi-texify-docstring
  (docstring)
  "Texify the doc string DOCSTRING.
Takes plain text formatting that may exist, and converts it to
using TeXinfo formatting.")