format args in docstrings as =code=, not /italic/

[gnu-emacs-elpa] / doc / yas-doc-helper.el

diff --git a/doc/yas-doc-helper.el b/doc/yas-doc-helper.el
index c940b2084c1bc7dae0899882cb821a79bcca3bf3..4969bdf470f04e4c678d621419475d8d558528a8 100755 (executable)
--- a/doc/yas-doc-helper.el
+++ b/doc/yas-doc-helper.el
@@ -34,12 +34,15 @@
   (flet ((concat-lines (&rest lines)
                        (mapconcat #'identity lines "\n")))
     (let* ((stars (make-string level ?*))
+           (args (and (fboundp symbol)
+                      (mapcar #'symbol-name (help-function-arglist symbol t))))
            (heading (cond ((fboundp symbol)
-                           (format "%s =%s= (%s)"
-                                   stars
-                                   symbol
-                                   (mapconcat #'symbol-name
-                                              (help-function-arglist symbol t) " ")))
+                           (format
+                            "%s =%s= (%s)" stars symbol
+                            (mapconcat (lambda (a)
+                                         (format (if (string-prefix-p "&" a)
+                                                     "/%s/" "=%s=") a))
+                                       args " ")))
                           (t
                            (format "%s =%s=\n" stars symbol))))
            (after-heading
@@ -57,12 +60,17 @@
                             (format "*WARNING*: no symbol named =%s=" symbol)))
                      (format "*WARNING*: no doc for symbol =%s=" symbol)))
            (case-fold-search nil))
-      ;; do some transformations on the body: FOO becomes /foo/ and
+      ;; do some transformations on the body:
+      ;; ARG becomes =arg=
+      ;; FOO becomes /foo/
       ;; `bar' becomes [[#bar][=bar=]]
       (setq body (replace-regexp-in-string
                   "[A-Z][A-Z-]+" #'(lambda (match)
-                                     (format "/%s/" (downcase match)))
-                  body)
+                                     (setq match (downcase match))
+                                     (format (if (member match args)
+                                                 "=%s=" "/%s/")
+                                             match))
+                  body t)
             body (replace-regexp-in-string "`\\([a-z-]+\\)'" #'(lambda (match)
                                                                  (let* ((name (downcase (match-string 1 match)))
                                                                         (sym (intern name)))