-
Notifications
You must be signed in to change notification settings - Fork 240
Home
Rene Saarsoo edited this page Feb 20, 2013
·
15 revisions
Documentation for JSDuck - API documentation generator for Sencha JavaScript frameworks.
- 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.
And a few more important resources:
Detailed docs for using all the builtin tags:
- @abstract
- @accessor
- @alias
- @alternateClassName
- @aside
- @author
- @cfg
- @chainable
- @class
- @constructor
- @deprecated
- @docauthor
- @enum
- @event
- @evented
- @example
- @extends
- @ftype
- @hide
- @ignore
- @inheritable
- @inheritdoc
- @markdown
- @member
- @method
- @mixins
- @new
- @override
- @param
- @preventable
- @private
- @property
- @protected
- @ptype
- @readonly
- @removed
- @requires
- @return
- @scss mixin
- @since
- @singleton
- @static
- @template
- @throws
- @type
- @uses
- @var
- @xtype
Also for the inline tags:
Various tags use {TypeDefinitions}, the syntax for these is described here:
Not enough? Want to make JSDuck do more for you?
-
Custom tags - The simplest way to add new functionality is to implement a custom tag. JSDuck supports loading custom tag definitions on the fly, without you having to fork JSDuck.
-
Hacking - If you really want to get down and dirty, this is the guide for you.