From: Sebastian Gniazdowski <psprint@zdharma.org>
To: Zsh Users <zsh-users@zsh.org>
Subject: Doxygen for shell scripts
Date: Sun, 10 Sep 2017 09:03:37 +0200 [thread overview]
Message-ID: <etPan.59b4e3ca.42b18817.134@zdharma.org> (raw)
Hello
I've written a documentation generator for shell scripts. Example outputs:
https://github.com/zdharma/zshelldoc/tree/master/examples
It is based on (z) flag, works very robust. Supported are things like autoload functions and calls between scripts. I think the most power comes from call trees and comment extraction – this allows to analyze the code – but I plan to add some more things, like detection of usage of Zle, eval, add-zsh-hook, etc.
--
Sebastian Gniazdowski
psprint /at/ zdharma.org
next reply other threads:[~2017-09-10 7:14 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-10 7:03 Sebastian Gniazdowski [this message]
2017-09-10 9:43 ` Nikolay Aleksandrovich Pavlov (ZyX)
2017-09-11 12:15 ` Sebastian Gniazdowski
2017-09-11 20:37 ` Nikolay Aleksandrovich Pavlov (ZyX)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=etPan.59b4e3ca.42b18817.134@zdharma.org \
--to=psprint@zdharma.org \
--cc=zsh-users@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).