Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Support generating API doc from Elvish sources #882
We have an
//elvdoc:fn name-of-function // Doc body //elvdoc:var name-of-variable // Doc body
And it is being used to generate parts of https://elv.sh/ref/edit.html. However, we do not have such a mechanism for Elvish sources yet, and as a result https://elv.sh/ref/epm.html is still written "by hand".
A similar tool that extracts doc comments from .elv files can be useful. Different from Go, since in .elv files you are always defining an Elvish API, we don't need the explicit
The tool can extract the comment above