ryuslash/edocs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Don't render "private" symbols

Browse source 
What constitutes a "private" symbol is determined by the new
`edocs-private-regexp' variable. Any symbol that matches this regexp is
considered private and not included in the formatted output.
This commit is contained in:
Tom Willemse 2013-12-28 20:54:55 +01:00
parent ef969855cc
commit d7a276e896
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
edocs.el
View file

@ -40,6 +40,9 @@
(defvar edocs-generate-only-body nil (defvar edocs-generate-only-body nil
"Whether to genereate only the body and no header/footer info.") "Whether to genereate only the body and no header/footer info.")
(defvar edocs-private-regexp "--"
"Regular expression to identify private parts of a module's API.")
(defconst edocs--symbol-type-map (defconst edocs--symbol-type-map
#s(hash-table size 8 test equal #s(hash-table size 8 test equal
data ("defclass" "Class" data ("defclass" "Class"
@ -69,10 +72,12 @@ etc."
" " " "
(group (1+ (not (any space ?\n ?\))))))) (group (1+ (not (any space ?\n ?\)))))))
nil :noerror) nil :noerror)
(setq ls (cons (cons (buffer-substring-no-properties (let ((type (buffer-substring-no-properties
(match-beginning 1) (match-end 1)) (match-beginning 1) (match-end 1)))
(buffer-substring-no-properties (name (buffer-substring-no-properties
(match-beginning 2) (match-end 2))) ls)))) (match-beginning 2) (match-end 2))))
(unless (string-match edocs-private-regexp name)
(setq ls (cons (cons type name) ls))))))
(reverse ls))) (reverse ls)))
(defun edocs--get-docs (type name) (defun edocs--get-docs (type name)