jsdoc - An API documentation generator for JavaScript.

  •        260

An API documentation generator for JavaScript.

http://usejsdoc.org
https://github.com/jsdoc3/jsdoc

Tags
Implementation
License
Platform

   




Related Projects

grunt-jsdoc - A grunt plugin to generate javascript doc by running jsdoc3 on your grunt projects.

  •    Javascript

This plugin enables you to integrate the generation of comments based documentation into your Grunt build. This plugin is a wrapper around jsdoc3. Please refer to the documentation for the documentation details.

documentation.js - Documentation for modern JavaScript

  •    Javascript

documentation.js is a documentation tool for mordern JavaScript. It Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations. It provides customizable output: HTML, JSON, Markdown, and more.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.This output can then be passed to a template for rendering. Look below at the "Properties" section for details.

VsDoc2JsDoc

  •    Javascript

The goal of this project is to convert VSDoc JavaScript comments of JayData classes to JSDoc comment format. Using this tool you can generate the API reference of your JayData components and keep your JavaScript documentation up-to-date.


ESDoc - Good Documentation for JavaScript

  •    Javascript

ESDoc is a documentation generator for JavaScript. It generates good documentation. It can measure documentation coverage, Integrate test codes into documentation, Parse ECMAScript proposals.

ECMADoc

  •    Javascript

ECMADoc generates professionally looking API documentation out of ECMAScript family of languages, such as JScript and JavaScript. Using the well known JDoc documentation format, developers can embed documentation right within the source code. This project is developed in C#.

yuidoc - YUI Javascript Documentation Tool

  •    HTML

YUI's JavaScript Documentation engine. YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.

tsdoc - A doc comment standard for the TypeScript language

  •    TypeScript

We are developing a library package @microsoft/tsdoc that provides an open source reference implementation of a parser. Using this library is an easy way to ensure that your tool is 100% compatible with the standard. These are just examples. Many other tools in today's web developer community want to interact with TypeScript doc comments. Each of these tools accepts a syntax that is loosely based on JSDoc, but encounters frustrating incompatibilities when attempting to coexist with other parsers.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

JavaScript documentation generator for node using markdown and jsdoc

DocumentJS - The sophisticated documentation engine

  •    Javascript

DocumentJS creates beautiful, articulate, multi-versioned documentation. With DocumentJS, you can Write documentation inline or in markdown files, Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations, Customize your site's theme and layout, Generate multi-version documentation.

minami - Clean and minimal JSDoc 3 Template / Theme

  •    Javascript

A clean, responsive documentation template theme for JSDoc 3. In your .jsdoc.json file, add a template option.

doctrine - JSDoc parser

  •    Javascript

Doctrine is a JSDoc parser that parses documentation comments from JavaScript (you need to pass in the comment, not a whole JavaScript file). Doctrine can also be used in web browsers using Browserify.

vim-jsdoc - Generate JSDoc to your JavaScript code.

  •    Vim

jsdoc.vim generates JSDoc block comments based on a function signature. Depending on your configuration, jsdoc.vim will prompt for description, @return type and description. It will also prompt you for types and descriptions for each function @param.

graphosaurus - 3D graph viewer powered by WebGL (three.js)

  •    Javascript

A three-dimensional static graph viewer. JSDoc generated API documentation can be found here.

roslibjs - The Standard ROS JavaScript Library

  •    Javascript

For full documentation, see the ROS wiki or check out some working demos. JSDoc can be found on the Robot Web Tools website.

pegaswitch - PegaSwitch is an exploit toolkit for the Nintendo Switch

  •    Javascript

It should no longer be necessary to run usefulscripts/SetupNew.js, since PegaSwitch will now do it automatically. API documentation for SploitCore is automatically generated using jsdoc comments.

pydoctor - Documentation Tool for Python

  •    Python

pydoctor is an API documentation tool for Python. It works by parsing the source code and processing the syntax trees of Python modules and packages, which has advantages and disadvantages over generating the documentation from examining live objects, as some other documentation tools do.

yard - YARD is a Ruby Documentation tool. The Y stands for "Yay!"

  •    Ruby

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Below is a summary of some of YARD's notable features. 1. RDoc/SimpleMarkup Formatting Compatibility: YARD is made to be compatible with RDoc formatting. In fact, YARD does no processing on RDoc documentation strings, and leaves this up to the output generation tool to decide how to render the documentation.

sphinx - Main repository for the Sphinx documentation builder

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.