[erlang-questions] [ANN] autohelp: include documentation in your modules

Danil Zagoskin <>
Sun Feb 17 20:18:37 CET 2013


Hello!

I'd like to announce autohelp parse_transform. It's goal is to be
non-intrusive but useful.

When module is compiled with this parse_transform, functions help/{0,1,2}
are added.
help/0 shows module description and function list,
help/1 shows short descriptions for functions with given name,
help/2 shows full description of function with given arity.

autohelp tries to avoid conflicts and if something goes wrong prints
warning and does not modify AST.

It is available on Github: https://github.com/stolen/autohelp

Hope you find it useful.


-- 
---------------------------------------------
Данил Загоскин | +7 906 064 20 47 | 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20130217/d1eb469b/attachment.html>


More information about the erlang-questions mailing list