Skip to content

Feature: API Docs#56

Open
rdwz wants to merge 2 commits into
helmasaur:mainfrom
astrological-guru:feat-api-docs
Open

Feature: API Docs#56
rdwz wants to merge 2 commits into
helmasaur:mainfrom
astrological-guru:feat-api-docs

Conversation

@rdwz

@rdwz rdwz commented Nov 30, 2023

Copy link
Copy Markdown

Everyone has probably seen something like this:

/**

  • This is a function.
  • @param {string} in - some param
  • @return {string} the result
    */

function foo(in) {
return out
}

And from there we can generate a complete Documentation of each available function

{
"scripts": {
"docs": "jsdoc2md index.js > docs/api.md"
}
}

@helmasaur

Copy link
Copy Markdown
Owner

Thank you for the PR! I will look at it for v2.0.0.

@helmasaur helmasaur self-requested a review May 1, 2026 23:54
@helmasaur helmasaur added this to the v2.0.0 milestone May 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants