11

I'd like to create an auto generating JSDoc documentation file for a framework I'm building but can't seem to find a way to output the documentation. Is it possible to output the doc to JSON or HTML? Or will I have to build my own JSDoc parser with RegExp?

I've looked all over the web and can't find anything on the subject.

Thank you.

Improve this question
8
  • 1
    Uhm: "Once your code is commented, you can use the JSDoc 3 Tool to generate an HTML website from the source. By default, JSDoc will use the "default" template to turn the documentation data into HTML. You can edit this template to suit your own needs, or create an entirely new template if that is what you prefer. ./jsdoc book.js This command will create a folder named "out" in the current working directory. Within that you will find the generated HTML pages." usejsdoc.org/about-getting-started.html ... seems like you looked all over the web but not the official documentation? Commented Feb 3, 2016 at 16:51
  • Always have a look at the official documentation first. Commented Feb 3, 2016 at 16:57
  • @FelixKling Thank you! I've been looking for the past 3 days... Never found that page. Commented Feb 3, 2016 at 16:59
  • 4
    The JSDoc documentation is terrible IMO. Kinda funny. Commented Apr 7, 2016 at 18:56
  • 1
    Strange that there's no information on that jsdoc site, on where to download the actual tool/binary Commented Aug 9, 2017 at 0:08

1 Answer 1

Reset to default
6

A big thanks to Felix Kling for pointing me the official documentation: usejsdoc.com

The documentation has been moved to https://jsdoc.app/

Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

According to this issue in the jsdoc Github repo, the official documentation has now been moved to jsdoc.app

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.