Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support generating API doc from Elvish sources #882

Open
xiaq opened this issue Dec 28, 2019 · 0 comments
Open

Support generating API doc from Elvish sources #882

xiaq opened this issue Dec 28, 2019 · 0 comments

Comments

@xiaq
Copy link
Member

@xiaq xiaq commented Dec 28, 2019

We have an elvdoc tool that can extract comments like the following from Go sources:

//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 //elvdoc: style comment; something similar to Go doc suffices. For example, in the following code:

# Does something
fn f { }

The tool can extract the comment above fn f as the API doc for the function.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.