Home

Jump to bottom Edit New page

kuprite edited this page Jul 26, 2021 · 15 revisions

Documentation for JSDuck - API documentation generator for Sencha (JavaScript frameworks.)

Guides

New in JSDuck 5
Installation - Help on installing JSDuck.
Usage - Running the JSDuck program.
Introduction to JSDuck - Overview of the main features. Start here.
Categories - List your classes in a systematic manner.
Guides - Write guides and tutorials in addition to API documentation.
Inline examples - Making the live code examples work.
Config file - Pack a load of command line options to a config file.

Overview of a bit more ad-hoc and experimental features:

Welcome page - Adding an index page for the generated docs.
[Videos] - Creating the videos page.
Examples - Creating the examples page.
Popup menu - Menu for navigating between different documentation projects.

Customizing JSDuck:

Custom tags - The simplest way to add new functionality to JSDuck.
Hacking - If you really want to get down and dirty.

And a few more important resources:

FAQ - Read this before submitting bugs.
Changelog - Overview of all the released versions.

Syntax

Detailed docs for using all the builtin tags:

Also for the inline tags:

Various tags use {TypeDefinitions}, the syntax for these is described here:

Type Definitions