| CARVIEW |
Select Language
HTTP/2 200
date: Thu, 24 Jul 2025 12:50:10 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-robots-tag: none
etag: W/"8dda66cbd334f01949c8a1857ced3b58"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=UX6H60XOpxc%2BBJu4nwP032HiqvThGzUGKS3UpWUBKFvmxAonjevdcgaN%2FnylqPB06ON2XE4TF%2BBxzZD2UYMe%2BXS3sZY%2BjtB1KL70t2JHPOVwpNy7BEJGDvyIA9%2F8xqcYyPW035QLGBlR4qDu87bwI9F0HtvoHquX395IW2ADCQfofqTLU4LG76sYkrP8LE3rIWU%2BA3DoIgYheXiumm4Cu7YZgvHBG6x%2FLMRAq1M93uqsvOhNdtpOLJ9qx0W4Fc7ga9n0G8ZX9LbUzDi0THPtXg%3D%3D--nYm4ls%2FZmkArADzg--IyoDhr%2B7d50g3M0tj3%2FGog%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.869669129.1753361409; Path=/; Domain=github.com; Expires=Fri, 24 Jul 2026 12:50:09 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Fri, 24 Jul 2026 12:50:09 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: C2A8:0A93:ABAC78:CB0D5D:68822C01
Home · senchalabs/jsduck Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 240
Home
kuprite edited this page Jul 26, 2021
·
15 revisions
Documentation for JSDuck - API documentation generator for Sencha (JavaScript frameworks.)
- 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:
Detailed docs for using all the builtin tags:
- @abstract
- @accessor
- @alias
- @alternateClassName
- @aside
- @author
- @cfg
- @chainable
- @class
- @constructor
- @deprecated
- @docauthor
- @enum
- @event
- @evented
- @example
- @experimental
- @extends
- @fires (in 5.x beta)
- @ftype
- @hide
- @ignore
- @inheritable
- @inheritdoc
- @localdoc (in 5.x beta)
- @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:
You can’t perform that action at this time.