Skip to content
Omnisense
Star0 FR

The packages / Omnidocs / Provider

omnidocs/jsdoc

Omnidocs JSDoc: a JavaScript library's API reference from the JSON JSDoc explains (jsdoc -X) - a page per global, its functions, methods and properties with their comments, parameters and source lines; a library of browser scripts (IIFE, UMD) named by the globals it sets.

composer require omnidocs/jsdoc:1.x-dev

No package of the ecosystem has a stable release yet: the command asks for its development branch.

Repository Packagist

Sheet

Floor
Provider · Omnidocs
Licence
MIT
Branch
1.x
Verified for real
Verified in part

- Not verified: ES modules (export function), whose doclets JSDoc names module:x~y - read, but no library of the ecosystem is written so; JSDoc's own @module, @namespace tags beyond their names.

From its README
Keywords
documentationapi referencejavascriptjsdocomnidocs

Manual

This package has neither a docs/ folder nor a README.

Dependencies

It requires

  • omnisense/omnidocs

    Omnidocs: one model of a manual, whatever wrote it - Markdown, Sphinx, Doxygen, JSDoc: its versions, its pages (title, contents, headings, the file to edit), its API entries and their anchors, read through one source contract; a search index a static page searches, and the HTML conventions of symfony.com/doc (callouts, versionadded, code with captions and tabs) every format renders to.

    Packagist · 1.x-dev Verified in part Manual