Displaying 1 to 5 from 5 results

getdocs - Getdocs is not JSDoc

  •    Javascript

Getdocs is like JSDoc or documentation.js, running over ES6 code to extract information and inline documentation in order to generate docs, but without all the @s. It takes source files and outputs JSON. The idea is to then feed this into a system (can be a simple set of templates) that massages it into actual human-readable documention files.

builddocs - Convert getdocs-style doc comments into HTML documentation

  •    Javascript

This is a utility that transforms code documented with getdocs-style doc comments into HTML. name: string The name of this module.

comment.js - Simple API Documentation Generator

  •    Javascript

Simple API Documentation Generator. The syntax for writing the comments was inspired by one of the firsts versions of dr.js by Dmitry Baranovskiy.




doc-tree - Documentation generating tool for JavaScript that matches comments to AST nodes.

  •    Javascript

doc-tree parses comments in JavaScript code and outputs the structure and context of the comments in any particular format, JSDoc is the default but any documentation parsing function can be supplied. It traverses the Abstract Syntax Tree (AST) to determine the context of a comment. Basically it's glue code between the AST parser Acorn, and the JSDoc parser Doctrine, though any user-supplied parsing function may be used. The output method accepts 2 arguments, a function that accepts a comment and returns anything, and an options object to pass to the custom function or the built-in parser, Doctrine.