/AutoLISP-DocGen

Automatic AutoLISP documentation generator

Primary LanguageCommon Lisp

automatic AutoLISP documentation generator
----------------------------------------------------
python lispdoc.py <--markdown|--html> <file.lsp>
----------------------------------------------------
Output: ./file.html | ./file.markdown
----------------------------------------------------
python markdown-dir.py <directory>
----------------------------------------------------
Output: markdown for each lsp file in directory

in autoLISP source files use following documentation style
;;; <LISPDOC>
;;; <SUBR>subroutine-name</SUBR>
;;; <ARG>argument1 - argument 1</ARG>
;;; <ARG>argument2 - argument 2</ARG>
;;; ...
;;; <RET>return \
;;; value
;;; </RET>
;;; <DESC>description of \
;;;  prograrm
;;;;</DESC>
;;; </LISPDOC>

"\" - acts like <br/> in html
----------------------------------------------------
for example:
;;; <LISPDOC>
;;; <SUBR>(my-cool-subr arg1 arg2)</SUBR>
;;; <DESC>Print two arguments</DESC>
;;; <ARG>arg1 - this is the first argument</ARG>
;;; <ARG>arg2 - this is the second argument</ARG>
;;; <RET>nil</RET>
;;; </LISPDOC>
(defun my-cool-subr (arg1 arg2)
  (princ arg1)
  (princ arg2)
  (princ))
----------------------------------------------------
Language: Python