ld/yasnippet
1
0
Fork 0
mirror of https://github.com/joaotavora/yasnippet.git synced 2025-10-13 21:13:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/yas-doc-helper.el: write documentation for "exported" symbols from docstrings

Browse Source 
doc/manual.org: some tweaks, use new yas--document-symbols
This commit is contained in:
Joao Tavora 2012-07-31 16:38:22 +01:00 committed by João Távora
parent 71c8e0ea46
commit c13abb7520
2 changed files with 164 additions and 1622 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1684
doc/manual.org
View File

File diff suppressed because it is too large Load Diff

102
doc/yas-doc-helper.el Executable file
View File

@ -0,0 +1,102 @@
;;; yas-doc-helper.el --- Help generate documentation for YASnippet
;; Copyright (C) 2012 João Távora
;; Author: João Távora <joaotavora@gmail.com>
;; Keywords: convenience
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Some functions to help generate YASnippet docs
;;; Code:
(defun yas--document-symbol (symbol level)
(flet ((concat-lines (&rest lines)
(mapconcat #'identity lines "\n")))
(let* ((stars (make-string level ?*))
(heading (cond ((fboundp symbol)
(format "%s =%s= (%s)"
stars
symbol
(mapconcat #'symbol-name
(help-function-arglist symbol t) " ")))
(t
(format "%s =%s=\n" stars symbol))))
(after-heading
(concat-lines ":PROPERTIES:"
(format ":CUSTOM_ID: %s" symbol)
":END:"))
(body (or (cond ((boundp symbol)
(documentation-property symbol 'variable-documentation t))
((fboundp symbol)
(documentation-property symbol 'function-documentation t))
(t
(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
;; `bar' becomes [[#bar][=bar=]]
(setq body (replace-regexp-in-string
"[A-Z][A-Z-]+" #'(lambda (match)
(format "/%s/" (downcase match)))
body)
body (replace-regexp-in-string "`\\([a-z-]+\\)'" #'(lambda (match)
(let* ((name (downcase (match-string 1 match)))
(sym (intern name)))
(if (and (or (boundp sym)
(fboundp sym))
(save-match-data
(string-match "^yas-" name)))
(format "[[#%s][=%s=]]"
name name)
(format "=%s=" name))))
body))
;; output the paragraph
;;
(concat-lines heading
after-heading
body))))
(defun yas--document-symbols (level &rest names-and-predicates)
(let ((sym-lists (make-vector (length names-and-predicates) (list)))
(retval ""))
(loop for sym in yas--exported-syms
do (loop for test in (mapcar #'cdr names-and-predicates)
for i from 0
do (when (funcall test sym)
(push sym (aref sym-lists i))
(return))))
(loop for slist across sym-lists
for name in (mapcar #'car names-and-predicates)
do (progn
(setq retval
(concat retval
(format "\n** %s\n" name)
(mapconcat #'yas--document-symbol slist "\n\n")))))
retval))
(defun yas--internal-link-snippet ()
(interactive)
(yas-expand-snippet "[[#$1][=${1:`yas/selected-text`}=]]"))
(define-key org-mode-map [M-f8] 'yas--internal-link-snippet)
(provide 'yas-doc-helper)
;;; yas-doc-helper.el ends here
;; Local Variables:
;; coding: utf-8
;; End: